REST API›Organization›Organization Management

GET

Global search across the organization

List of customers & transactions across the organization.

Query Params

  • searchTerm string required
    Free-text search term to match against customers and transactions

    at least 1 characters

  • searchType string enum
    Restrict results to customers or transactions only
    customerstransactions
  • 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

Responses

200

Response Body

object

  • userResults object required
    userResults object
    • users array of objects required
      users object
      • id string required
      • username string required
      • name object required
        name object
        • first string required
        • full string required
        • last string required
      • enterprises array of objects required
        enterprises object
        • permissions array of string enums required
          adminauditorwallet.create
        • id string
        • beneficialOwner boolean
        • primaryContact string
        • kycState string enum
          unverifiedapprovedrejectedpendingqrscannedinreviewflaggedflagged_retry_allowed
        • bitgoOrg string
        • name string
        • videoIdState string
        • videoIdLink string
      • email object required
        email object
        • email string required
        • verified boolean required
      • agreements object required
        agreements object
        • patriotAct number required
        • termsOfUse number required
        • patriotActAcceptanceDate string
        • termsOfUseAcceptanceDate string
      • allowedCoins array of strings required
      • bitgoEmployee boolean required
      • currency object required
        currency object
        • bitcoinUnit string required
        • currency string required
      • disableReset2FA boolean required
      • organizations array of objects required
        organizations object
        • permissions array of string enums required
          admin
        • role string enum required
          serviceUseradminmembercustomer
        • id string
        • name string
      • featureFlags array of strings required
      • forceResetPassword boolean required
      • identity object required
        identity object
        • kyc object
          kyc object
          • available boolean required
          • required boolean required
          • data object
            data object
            • state string enum required
              unverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
            • fields object

              ANY OF

              object

          • documents object
            documents object
            • state string enum required
              unverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
          • failureCount number
          • fullyRequired boolean
          • hasVideoID boolean
          • overallState string enum
            unverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
          • passport object
            passport object
            • required boolean required
            • state string enum
              unverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
          • residency object
            residency object
            • state string enum required
              unverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
          • ongoingScreening object
            ongoingScreening object
            • state string enum required
              approvedrejected
          • isScreeningRequired boolean
          • documentsWaived boolean
          • unverifiedPaygoUser boolean
          • enterpriseVideoCallInfo array of objects
            enterpriseVideoCallInfo object
            • enterpriseId string required
            • videoCallId string required
          • enhancedVerificationLevel string

            ANY OF

            string enum

        • verified boolean
      • otpDevices array of objects required
        otpDevices object
        • createDate string required
        • id string required
        • backupPhone string
        • label string
        • lastValidatedDate string
        • phone string
        • registeredKey object
          registeredKey object
          • certificate string
          • keyHandle string
          • publicKey string
        • type string enum
          authytotpu2fwebauthnyubikey
        • verified boolean
        • scopes array of string enums
          wallet_hot
        • extensions map of booleans
          extensions object
          • <key> boolean
        • prfSalt string
        • isPasskey boolean
        • credentialId string
      • phone object required
        phone object
        • phone string or object required
        • verified boolean required
      • timezone string required
      • apps object nullable
      • country string
      • ecdhKeychain string or object
      • isActive boolean
      • isFrozen boolean
      • freezeReason string
      • freeze object
        freeze object
        • time string
        • expires string
      • lastLogin string
      • locale string
      • pgpKey string
      • rateLimits object nullable
      • referrer object
        referrer object
        • campaign string or object
        • source string or object
      • signupDomain string
      • state string
      • sourceVerificationRequired boolean
      • sourceVerificationRequiredForReadOnlyAccess boolean
      • recoveryCodeSet object
        recoveryCodeSet object
        • id string required
        • allCodesUsed boolean required
      • createTime string
      • passwordUpdatedAt string
    • nextBatchPrevId string
  • transferResults object required
    transferResults object
    • transfers array of objects required
      transfers object
      • coin string required
      • date string required
      • entries array of objects required
        entries object
        • address string required
        • valueString string
        • isChange boolean
        • wallet string
        • walletLabel string
        • value number
        • nftSymbol string
        • type string enum
          flushForwarderTokenswalletFundingwalletInitializationaddressInitializationimportedOutputonchainidWalletLinkedonchainidClaimAddedonchainidClaimRemovedAccountCreateContract
        • 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 map of objects
          activityMetadata object
          • <key> object nullable
      • history array of objects required
        history object
        • action string enum required
          createdapprovedrejectedsignedunconfirmedconfirmedremovedcommentedfailedregeneratedreplacedreplacingreversedabandoned
        • date string required
        • comment string or object
        • transferId string
        • txid string
        • user string
      • id string required
      • state string enum required
        initializedpendingApprovalrejectedsignedunconfirmedconfirmedremovedfailedreplacedreverseddeleted
      • type string enum required
        sendreceive
      • valueString string required
      • wallet string required
      • baseValue number
      • baseValueString string
      • comment string or object
      • enterprise string
      • organization string
      • bitgoOrg string enum
        BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1BitGo Inc
      • pendingApproval string
      • stakingParams object
        stakingParams object
        • actionType string required
        • requestId string required
        • source string enum
          externalinternal
        • validator string
        • coreDao object
          coreDao object
          • validator string required
          • amount string required

            matches ^d+$

          • 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 string enum
        backingcoldcustodialcustodialPairedhotadvancedtrading
      • replaces array of strings
      • replacedBy array of strings
      • replacedByTransferId array of strings
      • riskIndicators array of string enums
        SELFDESTRUCT
      • baseValueWithoutFeesString string
      • baseValueWithoutFees number
      • coinSpecific object nullable
      • confirmations number
      • consolidateId string
      • feeString string or object
      • feeCoin string
      • sequenceId string
      • subType string enum
        ofc_depositofc_withdrawalofc_book_transferofc_exchangeofc_bn_settlement_transferofc_bn_allocationofc_trading_orderofc_trading_settlementofc_margin_collateralofc_margin_positionofc_direct_tradeofc_routedofc_feeofc_otherofc_unstakeofc_financing_liquidationreceive_from_gastankreserved_amountutxo_message_signingpending_depositpending_deposit_activityinternal_transferpending_withdrawal_offerpending_deposit_offeroffer_acceptedoffer_rejectedconfirmed_depositconfirmed_withdrawaldeposit_offer_expiredwithdrawal_offer_expiredwithdrawal_offer_rejectedutxo_expiredoffer_cancelledcancel_withdrawal_offermint_requestmint_offermint_acceptmint_depositmint_rejectburn_requestburn_offerburn_acceptburn_withdrawburn_rejectpending_participant_onboarding_requestparticipant_onboarding_acceptedpending_dtcc_end_investor_inviteend_investor_invite_offerend_investor_invite_acceptedend_investor_invite_rejectedpending_allocationallocation_acceptedcosign_delegation_offercosign_delegation_acceptedcash_dvp_settledrepo_dvp_open_leg_settledrepo_dvp_close_leg_settledstaking_eth_withdrawalstaking_eth_partial_withdrawalstaking_eth_full_withdrawalstaking_eth_mev_rewardstaking_eth_block_rewardstaking_bera_withdrawalstaking_bera_block_rewarddefi_deposit
      • txRequestId string
      • goStakingRequestId string
      • height number
      • heightId string
      • instant boolean
      • instantId string
      • isFee boolean
      • isReward boolean
      • isUnlock boolean
      • nSegwitInputs number
      • outputs array of objects
        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 array of objects
        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 array of objects
        metadata object
        • key string required
        • value string required
      • sendAccounting array of objects
        sendAccounting object
        • type string required
        • amountString string required
        • nOuts number required
        • amount number
        • id string
      • tags array of strings
      • txidType string
      • usersNotified boolean
      • vSize number
      • walletLabel string
      • enterpriseName string
      • elliptic string
      • senderInformationVerified boolean
      • buildParams map of objects
        buildParams object
        • <key> object nullable
      • 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
        sender object
        • address string required
        • walletId string
        • walletLabel string
        • valueString string
      • receiver array of objects required
        receiver object
        • address string required
        • walletId string
        • walletLabel string
        • valueString string
      • total object
        total object
        • fiatValue number
        • displayValue string
      • amountSent object
        amountSent object
        • fiatValue number
        • displayValue string
      • networkFee object
        networkFee object
        • fiatValue number
        • displayValue string
      • paygoFee object
        paygoFee object
        • fiatValue number
        • displayValue string
      • consolidateId string
      • withdrawHoldReleaseAt string
    • nextBatchPrevId string