GET
Global search across the organization
List of customers & transactions across the organization.
Query Params
-
searchTermstring required -
searchTypestring enumcustomerstransactions -
usersNextBatchPrevIdstring -
transfersNextBatchPrevIdstring -
limitstring -
organizationIdstring requiredThe ID of the organization -
orgIdstringOptional alias for organizationId; if provided, must match organizationId
Responses
200
Response Body
object
-
userResultsobjectuserResults object
-
usersarray of objects requiredusers object
-
idstring required -
usernamestring required -
nameobject requiredname object
-
firststring required -
fullstring required -
laststring required
-
-
enterprisesarray of objects requiredenterprises object
-
permissionsarray of strings required -
idstring -
beneficialOwnerboolean -
namestring
-
-
emailobject requiredemail object
-
emailstring required -
verifiedboolean required
-
-
agreementsobject requiredagreements object
-
patriotActnumber required -
termsOfUsenumber required -
patriotActAcceptanceDatestring -
termsOfUseAcceptanceDatestring
-
-
allowedCoinsarray of strings required -
bitgoEmployeeboolean required -
currencyobject requiredcurrency object
-
bitcoinUnitstring required -
currencystring required
-
-
disableReset2FAboolean required -
organizationsarray of objects requiredorganizations object
-
permissionsarray of string enums requiredadmin -
rolestring enum requiredadminmembercustomer -
idstring -
namestring
-
-
featureFlagsarray of strings required -
forceResetPasswordboolean required -
identityobject requiredidentity object
-
kycobjectkyc object
-
availableboolean required -
requiredboolean required -
dataobjectdata object
-
statestring enum requiredunverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed -
fieldsobjectANY OF
object
-
<key>object nullable
object
-
-
-
documentsobjectdocuments object
-
statestring enum requiredunverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
-
-
failureCountnumber -
fullyRequiredboolean -
hasVideoIDboolean -
overallStatestring enumunverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed -
passportobjectpassport object
-
requiredboolean required -
statestring enumunverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
-
-
residencyobjectresidency object
-
statestring enum requiredunverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
-
-
isScreeningRequiredboolean -
enterpriseVideoCallInfoarray of objectsenterpriseVideoCallInfo object
-
enterpriseIdstring required -
videoCallIdstring required
-
-
-
verifiedboolean
-
-
otpDevicesarray of objects requiredotpDevices object
-
createDatestring required -
idstring required -
backupPhonestring -
labelstring -
lastValidatedDatestring -
phonestring -
registeredKeyobjectregisteredKey object
-
certificatestring -
keyHandlestring -
publicKeystring
-
-
typestring enumauthytotpu2fwebauthnyubikey -
verifiedboolean -
scopesarray of string enumswallet_hot -
extensionsmap of booleansextensions object
-
<key>boolean
-
-
prfSaltstring
-
-
phoneobject requiredphone object
-
phonestring or object required -
verifiedboolean required
-
-
timezonestring required -
appsobject nullable -
countrystring -
ecdhKeychainstring or object -
isActiveboolean -
isFrozenboolean -
freezeReasonstring -
lastLoginstring -
localestring -
pgpKeystring -
rateLimitsobject nullable -
referrerobjectreferrer object
-
campaignstring or object -
sourcestring or object
-
-
signupDomainstring -
statestring -
sourceVerificationRequiredboolean -
sourceVerificationRequiredForReadOnlyAccessboolean -
recoveryCodeSetobjectrecoveryCodeSet object
-
idstring required -
allCodesUsedboolean required
-
-
-
nextBatchPrevIdstring
-
-
transferResultsobjecttransferResults object
-
transfersarray of objects requiredtransfers object
-
coinstring required -
datestring required -
entriesarray of objects requiredentries object
-
addressstring required -
valueStringstring -
isChangeboolean -
walletstring -
valuenumber -
nftSymbolstring -
typestring enumflushForwarderTokenswalletFundingwalletInitializationaddressInitializationimportedOutput
-
-
historyarray of objects requiredhistory object
-
actionstring enum requiredcreatedapprovedrejectedsignedunconfirmedconfirmedremovedcommentedfailedregeneratedreplacedreplacingabandoned -
datestring required -
commentstring or object -
transferIdstring -
txidstring -
userstring
-
-
idstring required -
statestring enum requiredinitializedpendingApprovalrejectedsignedunconfirmedconfirmedremovedfailedreplaceddeleted -
typestring enum requiredsendreceive -
valueStringstring required -
walletstring required -
baseValuenumber -
baseValueStringstring -
commentstring or object -
enterprisestring -
organizationstring -
bitgoOrgstring -
pendingApprovalstring -
stakingParamsobjectstakingParams object
-
actionTypestring required -
requestIdstring required -
sourcestring enumexternalinternal -
validatorstring
-
-
txidstring -
usdnumber -
usdRatenumber -
valuenumber -
replacesarray of strings -
replacedByarray of strings -
senderobject requiredsender object
-
addressstring required -
walletIdstring -
walletLabelstring -
valueStringstring
-
-
receiverarray of objects requiredreceiver object
-
addressstring required -
walletIdstring -
walletLabelstring -
valueStringstring
-
-
totalobjecttotal object
-
fiatValuenumber -
displayValuestring
-
-
amountSentobjectamountSent object
-
fiatValuenumber -
displayValuestring
-
-
networkFeeobjectnetworkFee object
-
fiatValuenumber -
displayValuestring
-
-
paygoFeeobjectpaygoFee object
-
fiatValuenumber -
displayValuestring
-
-
consolidateIdstring
-
-
nextBatchPrevIdstring
-