Ctrl+K

List users

get/api/v2/admin/user

Query Parameters

  • idarray[string]
    One or more user IDs
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • namestring
    partial match of a user's name (3 charaters min)
  • bitgoEmployeeboolean
    Get a list of all the bitgo employees and the admin roles assigned to them
  • isActiveboolean
    Can be used to retrieve active/non-active employee list
  • limitintegerDefault: 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}$

200 Response

users array[object] required
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isActive boolean
isFrozen boolean
freezeReason string
Example: Frozen due to suspicious activity
name object
username string <email>
Example: user@example.com
email object
phone object
country string
Example: USA
state string
Example: New York
kycStatus string
user's overall KYC status
Allowed values: approved pending rejected unverified
Example: approved
bitgoAdminRoles array[string]
List of admin roles assigned to the user

400 Response

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