User

Retrieve users

/users

Retrieve a paginated list of users. Supports data and state filtering, sorting, and pagination.

Request parameters

Responses

[
  {
    "id": 96,
    "username": "email@example.com",
    "status": "ACTIVE",
    "dateCreated": 1736505915,
    "dateModified": 1736505915,
    "isRegistered": true,
    "lastLogin": 1736505915,
    "mfaEnabled": [
      "google"
    ],
    "parentId": 96,
    "permissions": [
      96
    ],
    "zone": 96,
    "zones": [
      {
        "id": 1,
        "name": "Default"
      }
    ]
  }
]

Retrieve a user entity by id.

/user/{identifier}

Retrieve a user entity by id.

Request parameters

Responses

{
  "id": 96,
  "username": "email@example.com",
  "data": {
    "firstname": "Geoff",
    "lastname": "Rey"
  },
  "status": "ACTIVE",
  "dateCreated": 1736505915,
  "dateModified": 1736505915,
  "isRegistered": true,
  "lastLogin": 1736505915,
  "mfaEnabled": [
    "google"
  ],
  "parentId": 96,
  "permissions": [
    96
  ],
  "zone": 96,
  "zones": [
    {
      "id": 1,
      "name": "Default"
    }
  ]
}

Retrieve user audit log

/user/audit

Responses

Register or update a user device token

/user-device-token

Request parameters

{
  "token": "example",
  "data": {
    "device_type": "example",
    "os_version": "example"
  }
}

Responses

Retrieve current user configuration

/user/configuration

Responses

Check user onboarding status

/user/onboarding

Responses

Update onboarding progress

/user/onboarding

Responses

List user notifications

/user/notifications

Responses

Single Sign-On for user

/user/sso

Responses

List user wallet passes

/wallet-passes

Responses

Get details of a single wallet pass

/wallet-pass/{id}

Request parameters

Responses

01 September 2026