Skip to main content
GET
Get a list of app users

Authorizations

Authorization
string
header
required

Authorization: Bearer <SPIRII_API_KEY>

Query Parameters

limit
integer
default:50

Filter the total amount of items returned.

offset
integer
default:0

Skip the first N items in the result set.

Search across app user fields.

sortBy
enum<string>
default:createdAt

Property to sort by.

Available options:
id,
customerId,
firstName,
lastName,
email,
phoneNumber,
whitelabel,
createdAt
sortDirection
enum<string>
default:desc
Available options:
desc,
asc
createdAt
string

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

locationId
integer
voucherId
integer
include
integer

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

excludeLocationId
integer
operatorId
integer

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

companyId
integer

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

Response

data
object[]
required

The list of app users.

totalElements
integer
required

The total number of app users matching the filter.

offset
integer
required

The offset of the returned page.

limit
integer
required

The maximum number of items returned.

The search term used to filter the results.