Retrieve a list of user accounts

Retrieves a paginated list of user accounts.

Optional filters can be applied to refine the results, such as externalId which can be used to filter accounts based on your own identifier.

Required Scope: read:accounts


Required Role:

This endpoint is availble to clients using the client credentials grant.
When using the authorization code flow grant the authorized user must be an Owner to use this endpoint.

Query Params
string

The user's external ID.

uuid

The facility ID to filter down the results

string

Filter result by account creation date from this date. RFC3339 without milliseconds.

integer
1 to 100
Defaults to 10

The number of records to fetch.

integer
≥ 0
Defaults to 0

The number of records skipped.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json