Ctrl+K

List enterprise users

get/api/v1/enterprise/{enterpriseId}/user

Path Parameters

  • enterpriseIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Query Parameters

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

200 Response

adminUsers array[object]
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
username string <email>
Example: user@example.com
firstName string
User first name
Example: Jane
lastName string
User last name
Example: Doe
fullName string
User full name
Example: Jane Doe
isActive boolean
email object
verified boolean
User has verified their email
identity object
nonAdminUsers array[object]
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
username string <email>
Example: user@example.com
firstName string
User first name
Example: Jane
lastName string
User last name
Example: Doe
fullName string
User full name
Example: Jane Doe
isActive boolean
email object
verified boolean
User has verified their email
identity object
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 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

404 Response

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