List All Users with Owned Asset Codes

get

https://example.com/v1/admin/users

Get all users, including non-customer users, but include asset codes users own addresses in.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

length ≥ 1

\S

Text a username must contain, matched case-insensitively, matching every user when omitted.
A term of one or two characters must equal the whole username instead, so an finds AN
but not Daniel.

array of uuids

length between 1 and 200

Users to return, matching any one of them, returning every user when omitted.

verifier

array of strings

length between 1 and 200

Wallet verifiers to return the users of, matching any one of them, returning every user
when omitted.

verifier

user_type

array of objects

length between 1 and 200

Roles to return users of, matching any one of them, returning every role when omitted.

user_type

Allowed:

asset_code

array of strings

length between 1 and 200

Assets a returned user must hold an address in at least one of, returning every user when
omitted.

asset_code

vendor

array of strings

length between 1 and 200

Vendors a returned user must have an identity at at least one of, returning every user when
omitted.

vendor

include_archived

boolean

Whether to list archived users alongside active ones.

sort_by

string

enum

Allowed:

sort_dir

string

enum

Direction to order the results in.

Allowed:

page

integer

0 to 4294967295

Page number for paginated results.

page_size

integer

0 to 4294967295

Page size for paginated results.

Responses

400

The query string is missing a required parameter, or a parameter could not be parsed into its expected type.

401

Not authenticated

500

failed to get all users from database

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK