HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Get a list of app users

get
https://api.spirii.com/v2/app-users

Retrieves a paginated list of app users. Only available to operators with a whitelabel app.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 50

Filter the total amount of items returned.

integer
Defaults to 0

Skip the first N items in the result set.

string

Search across app user fields.

string
enum
Defaults to createdAt

Property to sort by.

string
enum
Defaults to desc
Allowed:
string

Filter by createdAt. ISO date or range joined by ellipsis, e.g. 2022-01-01...2022-02-01

integer
integer
integer

Ensure this app user id is included at the top of the first page.

integer
integer

Filter by operator (used when JWT has no permittedOperatorId).

integer

Filter by company (used when JWT has no permittedCompanyId).

Responses

400

Bad Request. An explanation message will be provided.

401

Unauthorized. The requested operation cannot be performed with the current access permissions.

403

Forbidden. Access is restricted to operators with a whitelabel app, or the request is otherwise not permitted.

500

An unexpected error occurred on the server while processing the request.

Updated 7 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago

Did this page help you?