List All Addresses for User

get

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

List every user's addresses, narrowed by the supplied filters and search terms.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

username

string

length ≥ 1

\S

Text a username must contain, matched case-insensitively, matching every username when
omitted. A term of one or two characters must equal the whole username instead.

address

string

length ≥ 1

\S

Text an address must contain, matched case-insensitively, matching every address when
omitted. A term of one or two characters must equal the whole address instead.

user_id

array of uuids

length between 1 and 200

Users whose addresses to return, matching any one of them, returning every user's when
omitted.

user_id

asset_code

array of strings

length between 1 and 200

Asset codes to return addresses for, matching any one of them, returning every asset's when
omitted.

asset_code

vendor

array of strings

length between 1 and 200

Custody vendors to return addresses for, matching any one of them, returning every vendor's
when omitted.

vendor

vault_id

array of strings

length between 1 and 200

Vaults to return addresses for, matching any one of them, returning every vault's when
omitted.

vault_id

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

Possible reasons:

search term must not be blank
unknown vendor

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

401

Not authenticated

500

Possible reasons:

failed to get all address list
invalid vendor

Language

Credentials

Loading…

Response

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

application/json

200OK