REST APIOrganizationOrganization Management

GET

List of customers & transactions across the organization.

Query Params

  • searchTerm string required

    at least 1 characters

  • searchType string enum
    customerstransactions
  • 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

Responses

200

Response Body

object

  • userResults object
    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 strings required
        • id string
        • beneficialOwner boolean
        • name 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
          adminmembercustomer
        • 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
          • isScreeningRequired boolean
          • enterpriseVideoCallInfo array of objects
            enterpriseVideoCallInfo object
            • enterpriseId string required
            • videoCallId string required
        • 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
      • 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
      • 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
    • nextBatchPrevId string
  • transferResults object
    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
        • value number
        • nftSymbol string
        • type string enum
          flushForwarderTokenswalletFundingwalletInitializationaddressInitializationimportedOutput
      • history array of objects required
        history object
        • action string enum required
          createdapprovedrejectedsignedunconfirmedconfirmedremovedcommentedfailedregeneratedreplacedreplacingabandoned
        • date string required
        • comment string or object
        • transferId string
        • txid string
        • user string
      • id string required
      • state string enum required
        initializedpendingApprovalrejectedsignedunconfirmedconfirmedremovedfailedreplaceddeleted
      • 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
      • pendingApproval string
      • stakingParams object
        stakingParams object
        • actionType string required
        • requestId string required
        • source string enum
          externalinternal
        • validator string
      • txid string
      • usd number
      • usdRate number
      • value number
      • replaces array of strings
      • replacedBy array of strings
      • 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
    • nextBatchPrevId string