GET

List enterprise users

Path Params

enterpriseId string required

The enterprise ID

matches ^[0-9a-f]{32}$

Query Params

allowInactiveUsers boolean

Whether inactive Users whose emails are unverified should be returned as well

Responses

200

Response Body

object

adminUsers array of objects
adminUsers object
- id string
  
  matches ^[0-9a-f]{32}$
- username string email
- firstName string
  
  User first name
- lastName string
  
  User last name
- fullName string
  
  User full name
- isActive boolean
- email object
  email object
  - email string email
  - verified boolean
    
    User has verified their email
- verified boolean
  
  User has verified their email
- identity object
  identity object
  - kyc object
    
    kyc object
    
    hasVideoID boolean
    
    User has done initial video ID
    
    overallState string enum
    
    approvedflaggedflagged_retry_allowedinreviewpendingrejectedunverified
    
    required boolean
    
    Sanction screening is required for this User
nonAdminUsers array of objects
nonAdminUsers object
- Same shape as EnterpriseUser.
count integer

The total number of Users returned.
incomplete boolean

Set to true if the Enterprise has at least 500 v1 or v2 wallets. If there are more than 500 wallets (either v1 or v2) it could mean that some Wallets were not considered for finding all Users.

400

Bad Request

Response Body

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

error string required

Human-readable error message
requestId string required

Client request id
context object required
context object
- id string
  
  matches ^[0-9a-f]{32}$
name string enum required

Error code

InvalidEnterpriseId

404

Not Found

Response Body

object

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

curl --request GET \ --url 'https://app.bitgo-test.com/api/v1/enterprise/enterpriseId/user&allowInactiveUsers=true' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/v1/enterprise/enterpriseId/user&allowInactiveUsers=true'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/v1/enterprise/enterpriseId/user&allowInactiveUsers=true") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/v1/enterprise/enterpriseId/user&allowInactiveUsers=true', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/v1/enterprise/enterpriseId/user&allowInactiveUsers=true" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "adminUsers": [ { "id": "59cd72485007a239fb00282ed480da1f", "username": "user@example.com", "firstName": "Jane", "lastName": "Doe", "fullName": "Jane Doe", "isActive": true, "email": { "email": "user@example.com", "verified": true }, "verified": true, "identity": { "kyc": { "hasVideoID": true, "overallState": "approved", "required": true } } } ], "nonAdminUsers": [ { "id": "59cd72485007a239fb00282ed480da1f", "username": "user@example.com", "firstName": "Jane", "lastName": "Doe", "fullName": "Jane Doe", "isActive": true, "email": { "email": "user@example.com", "verified": true }, "verified": true, "identity": { "kyc": { "hasVideoID": true, "overallState": "approved", "required": true } } } ], "count": 0, "incomplete": true }