> ## Documentation Index
> Fetch the complete documentation index at: https://developers.logicgate.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List users

> **Permissions:** Authenticated User

Retrieve a page of users matching the given statuses and search query.



## OpenAPI

````yaml GET /api/v1/internal/users
openapi: 3.1.0
info:
  title: Risk Cloud API
  description: >-
    The Risk Cloud API is a collection of RESTful API endpoints that empower you
    and your team to directly integrate, automate, and build with the Risk
    Cloud. Risk Cloud API endpoint payloads are JSON based, with some endpoints
    supporting exports in CSV and XSLX formats for flexible integration.


    This API documentation showcases our Risk Cloud API v1, containing a variety
    of endpoints with continued support for enabling integrations with the Risk
    Cloud.


    Visit the [LogicGate Risk Cloud Developer
    Portal](https://www.logicgate.com/developer/) to get started with building
    your custom integration with quick start guides, usage guides, release
    notes, and more. Or download the [v1 OpenAPI
    specification](/legacy-openapi.json).


    Explore our [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html)
    endpoints and documentation as well. [Risk Cloud API
    v2](https://docs.logicgate.com/v2/index.html) is our collection of API-First
    endpoints that are tailor made for our developer users, offer concise and
    highly documented details, are supported by a [Postman
    collection](https://www.postman.com/logicgate-postman/workspace/logicgate-risk-cloud-api/collection/29257227-de8d264b-6eeb-4177-bea6-2da0a8cabffc)
    and [v2 OpenAPI specification](https://github.com/LogicGateTech/openapi),
    and contain our latest API endpoint releases.
  contact:
    name: developer-relations@logicgate.com
    email: developer-relations@logicgate.com
  version: v2026.11.0
servers:
  - url: https://{subdomain}.logicgate.com
    description: Your Risk Cloud environment.
    variables:
      subdomain:
        description: Your Risk Cloud environment's subdomain (e.g. `qa`).
        default: your-instance
security:
  - ApiToken: []
  - basic: []
tags:
  - name: Authentication
    description: >-
      Getting Started: How to create an [API Access
      Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/)
      to begin integrating with the Risk Cloud API
  - name: Attachment
    description: Endpoints for uploading, downloading, and retrieving record attachments.
  - name: Field
    description: Endpoints for creating, updating, and querying fields.
  - name: Principal
    description: >-
      Endpoints for the authenticated principal to view and manage their own
      details.
  - name: Record Audit
    description: Endpoints for retrieving record audit history and productivity data.
  - name: Step
    description: Endpoints for retrieving steps and the steps a user can access.
  - name: Table Report
    description: Endpoints for retrieving and managing table reports.
  - name: User Group
    description: Endpoints for managing user groups and their membership.
externalDocs:
  description: Developer Portal
  url: https://www.logicgate.com/developer/
paths:
  /api/v1/internal/users:
    get:
      tags:
        - User
      summary: List users
      description: |-
        **Permissions:** Authenticated User

        Retrieve a page of users matching the given statuses and search query.
      operationId: findAllByStatuses
      parameters:
        - name: statuses
          in: query
          description: >-
            User statuses to include (e.g. ACTIVE, DISABLED). Defaults to all
            statuses.
          required: false
          schema:
            type: array
            default: []
            items:
              type: string
        - name: query
          in: query
          description: Search text matched against user name and email.
          required: true
          schema:
            type: string
        - name: search-type
          in: query
          description: Which user fields the query is matched against. Defaults to ALL.
          required: false
          schema:
            type: string
            default: ALL
            enum:
              - ALL
              - EMAIL
              - NAME
              - USER_ID
        - name: filter
          in: query
          description: Filter users by account source (e.g. SCIM). Defaults to ALL_SOURCES.
          required: false
          schema:
            type: string
            default: ALL_SOURCES
            enum:
              - RISK_CLOUD
              - IDENTITY_PROVIDER
              - ALL_SOURCES
        - name: pageable
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/Pageable_UserPageSummary'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageUser_UserPageSummary'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStatusResponse_UserPageSummary'
components:
  schemas:
    Pageable_UserPageSummary:
      type: object
      properties:
        paged:
          type: boolean
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        sort:
          $ref: '#/components/schemas/SortObject_UserPageSummary'
        unpaged:
          type: boolean
        offset:
          type: integer
          format: int64
    PageUser_UserPageSummary:
      type: object
      properties:
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int32
        first:
          type: boolean
        last:
          type: boolean
        numberOfElements:
          type: integer
          format: int32
        pageable:
          $ref: '#/components/schemas/Pageable_UserPageSummary'
        sort:
          $ref: '#/components/schemas/SortObject_UserPageSummary'
        size:
          type: integer
          format: int32
        content:
          type: array
          items:
            $ref: '#/components/schemas/User_UserPageSummary'
        number:
          type: integer
          format: int32
        empty:
          type: boolean
    AppStatusResponse_UserPageSummary:
      type: object
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
          format: int32
        detail:
          type: string
        instance:
          type: string
          format: uri
        properties:
          type: object
          additionalProperties: {}
    SortObject_UserPageSummary:
      type: object
      properties:
        sorted:
          type: boolean
        unsorted:
          type: boolean
        empty:
          type: boolean
    User_UserPageSummary:
      allOf:
        - $ref: '#/components/schemas/CurrentValue_UserPageSummary'
        - type: object
          properties:
            email:
              type: string
            company:
              type: string
            imageUrl:
              type: string
            status:
              type: string
            tier:
              type: string
              enum:
                - PRIMARY
                - SECONDARY
                - LIMITED
            pricingUserTier:
              type: string
              enum:
                - STANDARD
                - POWER
            first:
              type: string
            last:
              type: string
            mfaEnabled:
              type: boolean
            mfaSetup:
              type: boolean
            autoprovisioned:
              type: boolean
            scimStatus:
              type: string
            allowLocalLogin:
              type: boolean
            automatedUser:
              type: boolean
            automatedUserFieldLabels:
              type: array
              items:
                type: string
            lastLogin:
              $ref: '#/components/schemas/AccessAudit_UserPageSummary'
            lastDeactivated:
              type: string
              format: date-time
            external:
              type: boolean
            disabled:
              type: boolean
            serviceAccount:
              type: boolean
            superUser:
              type: boolean
            name:
              type: string
            locked:
              type: boolean
      description: Entity for storing all information pertaining to a user.
      discriminator:
        propertyName: status
      oneOf:
        - description: Circular reference to Active_UserPageSummary
        - description: >-
            And other types: Automated_UserPageSummary,
            Disabled_UserPageSummary, External_UserPageSummary,
            Locked_UserPageSummary, Service_UserPageSummary
      properties:
        status:
          type: string
      required:
        - status
    CurrentValue_UserPageSummary:
      type: object
      description: Entity used to manage record's field data.
      discriminator:
        propertyName: discriminator
      oneOf:
        - $ref: '#/components/schemas/CurrentCommonValue_UserPageSummary'
        - description: >-
            And other types: CurrentDateValue_UserPageSummary,
            CurrentDateRangeValue_UserPageSummary,
            CurrentJobValue_UserPageSummary, CurrentCommonValue_UserPageSummary,
            CurrentDateValue_UserPageSummary,
            CurrentDateRangeValue_UserPageSummary, LabelValue_UserPageSummary,
            CleanAttachment_UserPageSummary, DirtyAttachment_UserPageSummary,
            PendingAttachment_UserPageSummary,
            CurrentGoogleAttachmentValue_UserPageSummary,
            CurrentSharepointAttachmentValue_UserPageSummary,
            Active_UserPageSummary, Automated_UserPageSummary,
            Disabled_UserPageSummary, External_UserPageSummary,
            Locked_UserPageSummary, Service_UserPageSummary,
            CurrentNumericRangeValue_UserPageSummary,
            CurrentJobValue_UserPageSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        discriminator:
          type: string
        idOrTransientId:
          type: string
        transientIdOrId:
          type: string
        textOrNumericValue:
          type: string
        empty:
          type: boolean
      required:
        - active
        - created
        - discriminator
        - id
        - updated
    AccessAudit_UserPageSummary:
      type: object
      description: Entity used to track authentication attempts.
      discriminator:
        propertyName: accessType
      oneOf:
        - $ref: '#/components/schemas/LogIn_UserPageSummary'
        - description: >-
            And other types: LogOut_UserPageSummary, LogInFail_UserPageSummary,
            CredentialsRolled_UserPageSummary, TokenRolled_UserPageSummary,
            LogIn_UserPageSummary, LogOut_UserPageSummary,
            LogInFail_UserPageSummary, CredentialsRolled_UserPageSummary,
            TokenRolled_UserPageSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        accessType:
          type: string
      required:
        - accessType
        - active
        - created
        - id
        - updated
    CurrentCommonValue_UserPageSummary:
      allOf:
        - description: Circular reference to CurrentValue_UserPageSummary
      required:
        - description
    LogIn_UserPageSummary:
      allOf:
        - description: Circular reference to AccessAudit_UserPageSummary
      required:
        - accessType
  securitySchemes:
    ApiToken:
      type: http
      scheme: bearer
      bearerFormat: API Token
    basic:
      type: http
      scheme: basic

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.