Ctrl+K

Get a list of internal Users based on a list of given Ids

get/api/v2/internal/users

Internal route to get user objects given a list of user IDs

Query Parameters

  • limitstring<number>Default: 25
    Maximum number of results to return. If the result set is truncated, use the "nextBatchPrevId" value to get the next batch.
    Minimum: >= 1
    Maximum: <= 500
  • prevIdstring
    Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • idsarray[string]Required
    A list of user IDs
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}
    Min length: >= 1 characters

200 Response

users array[object] required
agreements object required
The agreements the user has accepted
allowedCoins array[string] required
The coins the user is allowed to use
bitgoEmployee boolean required
Whether the user is a BitGo employee
currency object required
The user's preferred currency
disableReset2FA boolean required
Whether the user has disabled 2FA reset
organizations array[object] required
The organizations the user is a member of
featureFlags array[string] required
Any feature flags the user has enabled
forceResetPassword boolean required
Whether the user has forced a password reset
identity object required
The user's identity information
otpDevices array[object] required
The user's devices that can be used for OTP authentication
phone object required
The user's phone number
timezone string required
The user's timezone
apps
The apps the user has access to
country string
The country of the user
Example: USA
ecdhKeychain
string or null
The user's ECDH keychain
isActive boolean
Whether the user is active
isFrozen boolean
Whether the user is frozen
freezeReason string
The reason the user is frozen if they are frozen
Example: Frozen due to suspicious activity
freeze object
Freeze object that will hold the start time and expiration time of a user's freeze. By default the freeze is infinite, and this field will eventually override the isFrozen boolean field
lastLogin string <date-time>
The last login time of the user
locale string
The user's locale
pgpKey string
The user's PGP key
rateLimits
The rate limits applied to the user
referrer object
The referrer of the user
signupDomain string
The signup domain of the user
state string
The state of the user
Example: New York
sourceVerificationRequired boolean
Whether source verification is required for the user
sourceVerificationRequiredForReadOnlyAccess boolean
Whether source verification is required for read-only access
recoveryCodeSet object
The recovery code set for the user
createTime string
passwordUpdatedAt string <date-time>
id string required
The unique identifier for the user
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
username string <email>required
The username of the user
Example: user@email.com
name object required
The name of the user
enterprises array[object] required
The enterprise(s) the user is a member of
email object required
The email address of the user
nextBatchPrevId string
The ID of the last user in the current batch. Use this value as the "prevId" query parameter to get the next batch of users.

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id