---
title: "List users across the organization"
method: GET
path: "/api/org/users"
tags: ["Organization Management"]
---

# List users across the organization

`GET /api/org/users`

List users across the organization

## Query parameters

- `organizationId` string, required — The ID of the organization to list users for
- `userId` string — Filter to a single user by id
- `username` string — Filter to a single user by username
- `search` string — Free-text search across user name and email
- `limit` union — Maximum number of users to return in this page
  - number
  - string
- `prevId` string — Cursor from a previous response's nextBatchPrevId, for pagination
- `role` union — Filter by one or more organization roles
  - string[]
  - 'admin' | 'member' | 'customer' | 'serviceUser'

## Response `200`

- object
  - `users` object[], required
    - `id` string, required
    - `username` string, required
    - `name` object, required
      - `first` string, required
      - `full` string, required
      - `last` string, required
    - `enterprises` object[], required
      - `permissions` string[], required
      - `id` string
      - `beneficialOwner` boolean
      - `primaryContact` string
      - `kycState` 'unverified' | 'approved' | 'rejected' | 'pending' | 'qrscanned' | 'inreview' | 'flagged' | 'flagged_retry_allowed'
      - `bitgoOrg` string
      - `name` string
      - `videoIdState` string
      - `videoIdLink` string
    - `email` object, required
      - `email` string, required
      - `verified` boolean, required
    - `agreements` object, required
      - `patriotAct` number, required
      - `termsOfUse` number, required
      - `patriotActAcceptanceDate` string
      - `termsOfUseAcceptanceDate` string
    - `allowedCoins` string[], required
    - `bitgoEmployee` boolean, required
    - `currency` object, required
      - `bitcoinUnit` string, required
      - `currency` string, required
    - `disableReset2FA` boolean, required
    - `organizations` object[], required
      - `permissions` string[], required
      - `role` 'serviceUser' | 'admin' | 'member' | 'customer', required
      - `id` string
      - `name` string
    - `featureFlags` string[], required
    - `forceResetPassword` boolean, required
    - `identity` object, required
      - `kyc` object
        - `available` boolean, required
        - `required` boolean, required
        - `data` object
          - `state` 'unverified' | 'pending' | 'approved' | 'rejected' | 'qrscanned' | 'inreview' | 'flagged' | 'flagged_retry_allowed', required
          - `fields` union
            - unknown
            - object
            - unknown
        - `documents` object
          - `state` 'unverified' | 'pending' | 'approved' | 'rejected' | 'qrscanned' | 'inreview' | 'flagged' | 'flagged_retry_allowed', required
        - `failureCount` number
        - `fullyRequired` boolean
        - `hasVideoID` boolean
        - `overallState` 'unverified' | 'pending' | 'approved' | 'rejected' | 'qrscanned' | 'inreview' | 'flagged' | 'flagged_retry_allowed'
        - `passport` object
          - `required` boolean, required
          - `state` 'unverified' | 'pending' | 'approved' | 'rejected' | 'qrscanned' | 'inreview' | 'flagged' | 'flagged_retry_allowed'
        - `residency` object
          - `state` 'unverified' | 'pending' | 'approved' | 'rejected' | 'qrscanned' | 'inreview' | 'flagged' | 'flagged_retry_allowed', required
        - `ongoingScreening` object
          - `state` 'approved' | 'rejected', required
        - `isScreeningRequired` boolean
        - `documentsWaived` boolean
        - `unverifiedPaygoUser` boolean
        - `enterpriseVideoCallInfo` object[]
          - `enterpriseId` string, required
          - `videoCallId` string, required
        - `enhancedVerificationLevel` union
          - 'L0'
          - 'L1'
          - 'L2'
          - 'L3'
      - `verified` boolean
    - `otpDevices` object[], required
      - `createDate` string, required
      - `id` string, required
      - `backupPhone` string
      - `label` string
      - `lastValidatedDate` string
      - `phone` string
      - `registeredKey` object
        - `certificate` string
        - `keyHandle` string
        - `publicKey` string
      - `type` 'authy' | 'totp' | 'u2f' | 'webauthn' | 'yubikey'
      - `verified` boolean
      - `scopes` string[]
      - `extensions` object
      - `prfSalt` string
      - `isPasskey` boolean
      - `credentialId` string
    - `phone` object, required
      - `phone` union, required
        - string
        - unknown
        - unknown
      - `verified` boolean, required
    - `timezone` string, required
    - `apps` unknown
    - `country` string
    - `ecdhKeychain` union
      - string
      - unknown
      - unknown
    - `isActive` boolean
    - `isFrozen` boolean
    - `freezeReason` string
    - `freeze` object
      - `time` string
      - `expires` string
    - `lastLogin` string
    - `locale` string
    - `pgpKey` string
    - `rateLimits` unknown
    - `referrer` object
      - `campaign` union
        - string
        - unknown
        - unknown
      - `source` union
        - string
        - unknown
        - unknown
    - `signupDomain` string
    - `state` string
    - `sourceVerificationRequired` boolean
    - `sourceVerificationRequiredForReadOnlyAccess` boolean
    - `recoveryCodeSet` object
      - `id` string, required
      - `allCodesUsed` boolean, required
    - `createTime` string
    - `passwordUpdatedAt` string
  - `nextBatchPrevId` string

---

[API](https://skmtc.net/bitgo/apis/bitgo-api.md) · [All operations](https://skmtc.net/bitgo/apis/bitgo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitgo/bitgo-api/revisions/e445c15e5bee/schema)