Skip to main content
GET
/
app-users
Retrieve a list of app users
curl --request GET \
  --url https://api.spirii.com/app-users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "email": "John.doe@gmail.com",
      "phoneNumber": "+45 11 22 33 44",
      "whitelabel": "label",
      "newsletter": false,
      "createdAt": "2021-04-20T14:38:20.000Z"
    },
    {
      "id": 2,
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "Jane.doe@gmail.com",
      "phoneNumber": null,
      "whitelabel": "label",
      "newsletter": false,
      "createdAt": "2021-04-20T12:10:31.000Z"
    }
  ],
  "totalElements": 16,
  "offset": 0,
  "limit": 2
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
email
string

Only retrieve app users with a specific e-mail address

Example:

"john.doe@gmail.com"

​
phoneNumber
string

Only retrieve app users with a specific phone number (including country code)

Example:

"+45 22 33 44 55"

​
crmId
integer
Example:

1

​
offset
integer

The number of items to skip before starting to collect the result set

Example:

250

​
limit
integer
default:250

Number of record to collect

Required range: x <= 2000
Example:

250

Response

App Users Data

​
data
object[]
required

App Users data