---
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 — Free-text search term to match against customers and transactions
- `searchType` 'customers' | 'transactions' — Restrict results to customers or transactions only
- `usersNextBatchPrevId` string — Cursor for the next page of user results
- `transfersNextBatchPrevId` string — Cursor for the next page of transfer results
- `limit` string — Maximum number of results to return per result type
- `organizationId` string, required — The ID of the organization
- `orgId` string — Optional alias for organizationId; if provided, must match organizationId

## Response `200`

- object
  - `userResults` object, required
    - `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
              - …
          - `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
  - `transferResults` object, required
    - `transfers` object[], required
      - `coin` string, required
      - `date` string, required
      - `entries` object[], required
        - `address` string, required
        - `valueString` string
        - `isChange` boolean
        - `wallet` string
        - `walletLabel` string
        - `value` number
        - `nftSymbol` string
        - `type` 'flushForwarderTokens' | 'walletFunding' | 'walletInitialization' | 'addressInitialization' | 'importedOutput' | 'onchainidWalletLinked' | 'onchainidClaimAdded' | 'onchainidClaimRemoved' | 'AccountCreateContract'
        - `isPayGo` boolean
        - `token` string
        - `failed` boolean
        - `associatedNativeCoinAddress` string
        - `isFee` boolean
        - `isInternal` boolean
        - `memo` string
        - `rewardAddress` string
        - `subtype` string
        - `backingFeeString` string
        - `nftId` string
        - `tokenContractHash` string
        - `isReward` boolean
        - `activityMetadata` object
      - `history` object[], required
        - `action` 'created' | 'approved' | 'rejected' | 'signed' | 'unconfirmed' | 'confirmed' | 'removed' | 'commented' | 'failed' | 'regenerated' | 'replaced' | 'replacing' | 'reversed' | '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' | 'reversed' | '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` 'BitGo Trust' | 'BitGo New York' | 'BitGo Germany' | 'BitGo Switzerland' | 'BitGo Europe ApS' | 'Frankfurt DE Trust' | 'BitGo Singapore' | 'BitGo Korea' | 'BitGo Custody MENA FZE' | 'BitGo India' | 'BitGo Sister Trust 1' | 'BitGo Inc'
      - `pendingApproval` string
      - `stakingParams` object
        - `actionType` string, required
        - `requestId` string, required
        - `source` 'external' | 'internal'
        - `validator` string
        - `coreDao` object
          - `validator` string, required
          - `amount` string, required
          - `expiration` string, required
          - `rewardAddress` string, required
          - `version` number, required
          - `fee` number, required
        - `resource` string
        - `amount` string
        - `receiverAddress` string
      - `txid` string
      - `usd` number
      - `usdRate` number
      - `medianUsdValue` number
      - `medianUsdRate` number
      - `feeUsd` number
      - `feeUsdRate` number
      - `value` number
      - `walletType` 'backing' | 'cold' | 'custodial' | 'custodialPaired' | 'hot' | 'advanced' | 'trading'
      - `replaces` string[]
      - `replacedBy` string[]
      - `replacedByTransferId` string[]
      - `riskIndicators` string[]
      - `baseValueWithoutFeesString` string
      - `baseValueWithoutFees` number
      - `coinSpecific` unknown
      - `confirmations` number
      - `consolidateId` string
      - `feeString` union
        - string
        - unknown
        - unknown
      - `feeCoin` string
      - `sequenceId` string
      - `subType` 'ofc_deposit' | 'ofc_withdrawal' | 'ofc_book_transfer' | 'ofc_exchange' | 'ofc_bn_settlement_transfer' | 'ofc_bn_allocation' | 'ofc_trading_order' | 'ofc_trading_settlement' | 'ofc_margin_collateral' | 'ofc_margin_position' | 'ofc_direct_trade' | 'ofc_routed' | 'ofc_fee' | 'ofc_other' | 'ofc_unstake' | 'ofc_financing_liquidation' | 'receive_from_gastank' | 'reserved_amount' | 'utxo_message_signing' | 'pending_deposit' | 'pending_deposit_activity' | 'internal_transfer' | 'pending_withdrawal_offer' | 'pending_deposit_offer' | 'offer_accepted' | 'offer_rejected' | 'confirmed_deposit' | 'confirmed_withdrawal' | 'deposit_offer_expired' | 'withdrawal_offer_expired' | 'withdrawal_offer_rejected' | 'utxo_expired' | 'offer_cancelled' | 'cancel_withdrawal_offer' | 'mint_request' | 'mint_offer' | 'mint_accept' | 'mint_deposit' | 'mint_reject' | 'burn_request' | 'burn_offer' | 'burn_accept' | 'burn_withdraw' | 'burn_reject' | 'pending_participant_onboarding_request' | 'participant_onboarding_accepted' | 'pending_dtcc_end_investor_invite' | 'end_investor_invite_offer' | 'end_investor_invite_accepted' | 'end_investor_invite_rejected' | 'pending_allocation' | 'allocation_accepted' | 'cosign_delegation_offer' | 'cosign_delegation_accepted' | 'cash_dvp_settled' | 'repo_dvp_open_leg_settled' | 'repo_dvp_close_leg_settled' | 'staking_eth_withdrawal' | 'staking_eth_partial_withdrawal' | 'staking_eth_full_withdrawal' | 'staking_eth_mev_reward' | 'staking_eth_block_reward' | 'staking_bera_withdrawal' | 'staking_bera_block_reward' | 'defi_deposit'
      - `txRequestId` string
      - `goStakingRequestId` string
      - `height` number
      - `heightId` string
      - `instant` boolean
      - `instantId` string
      - `isFee` boolean
      - `isReward` boolean
      - `isUnlock` boolean
      - `nSegwitInputs` number
      - `outputs` object[]
        - `chain` number
        - `index` number
        - `redeemScript` string
        - `witnessScript` string
        - `id` string
        - `address` string
        - `value` number
        - `blockHeight` number
        - `coinbase` boolean
      - `payGoFee` number
      - `payGoFeeString` string
      - `inputs` object[]
        - `chain` number
        - `index` number
        - `redeemScript` string
        - `witnessScript` string
        - `id` string
        - `address` string
        - `value` number
        - `blockHeight` number
        - `coinbase` boolean
      - `intendedValueString` string
      - `label` string
      - `metadata` object[]
        - `key` string, required
        - `value` string, required
      - `sendAccounting` object[]
        - `type` string, required
        - `amountString` string, required
        - `nOuts` number, required
        - `amount` number
        - `id` string
      - `tags` string[]
      - `txidType` string
      - `usersNotified` boolean
      - `vSize` number
      - `walletLabel` string
      - `enterpriseName` string
      - `elliptic` string
      - `senderInformationVerified` boolean
      - `buildParams` object
      - `createdTime` string
      - `approvedTime` string
      - `rejectedTime` string
      - `signedTime` string
      - `unconfirmedTime` string
      - `confirmedTime` string
      - `removedTime` string
      - `commentedTime` string
      - `failedTime` string
      - `regeneratedTime` string
      - `replacedTime` string
      - `replacingTime` string
      - `abandonedTime` string
      - `signedDate` string
      - `customerApprovedTime` string
      - `idVerificationTime` string
      - `trustSignedTime` string
      - `trustFinalApprovalTime` 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
      - `withdrawHoldReleaseAt` 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)