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

# Global search across the organization

`GET /api/org/search`

List of customers & transactions across the organization.

## Query parameters

- `searchTerm` string, required
- `searchType` 'customers' | 'transactions'
- `usersNextBatchPrevId` string
- `transfersNextBatchPrevId` string
- `limit` string
- `organizationId` string, required — The ID of the organization
- `orgId` string — Optional alias for organizationId; if provided, must match organizationId

## Response `200`

- object
  - `userResults` 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
        - `name` 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` '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
              - …
          - `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
          - `isScreeningRequired` boolean
          - `enterpriseVideoCallInfo` object[]
            - `enterpriseId` string, required
            - `videoCallId` string, required
        - `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
      - `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
      - `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
    - `nextBatchPrevId` string
  - `transferResults` object
    - `transfers` object[], required
      - `coin` string, required
      - `date` string, required
      - `entries` object[], required
        - `address` string, required
        - `valueString` string
        - `isChange` boolean
        - `wallet` string
        - `value` number
        - `nftSymbol` string
        - `type` 'flushForwarderTokens' | 'walletFunding' | 'walletInitialization' | 'addressInitialization' | 'importedOutput'
      - `history` object[], required
        - `action` 'created' | 'approved' | 'rejected' | 'signed' | 'unconfirmed' | 'confirmed' | 'removed' | 'commented' | 'failed' | 'regenerated' | 'replaced' | 'replacing' | 'abandoned', required
        - `date` string, required
        - `comment` union
          - string
          - unknown
          - unknown
        - `transferId` string
        - `txid` string
        - `user` string
      - `id` string, required
      - `state` 'initialized' | 'pendingApproval' | 'rejected' | 'signed' | 'unconfirmed' | 'confirmed' | 'removed' | 'failed' | 'replaced' | 'deleted', required
      - `type` 'send' | 'receive', required
      - `valueString` string, required
      - `wallet` string, required
      - `baseValue` number
      - `baseValueString` string
      - `comment` union
        - string
        - unknown
        - unknown
      - `enterprise` string
      - `organization` string
      - `bitgoOrg` string
      - `pendingApproval` string
      - `stakingParams` object
        - `actionType` string, required
        - `requestId` string, required
        - `source` 'external' | 'internal'
        - `validator` string
      - `txid` string
      - `usd` number
      - `usdRate` number
      - `value` number
      - `replaces` string[]
      - `replacedBy` string[]
      - `sender` object, required
        - `address` string, required
        - `walletId` string
        - `walletLabel` string
        - `valueString` string
      - `receiver` object[], required
        - `address` string, required
        - `walletId` string
        - `walletLabel` string
        - `valueString` string
      - `total` object
        - `fiatValue` number
        - `displayValue` string
      - `amountSent` object
        - `fiatValue` number
        - `displayValue` string
      - `networkFee` object
        - `fiatValue` number
        - `displayValue` string
      - `paygoFee` object
        - `fiatValue` number
        - `displayValue` string
      - `consolidateId` string
    - `nextBatchPrevId` string

---

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