HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

User devices / Listing

Get a list of user devices registered by the mobile app.

Devices are created when the mobile app first communicates with the platform.
A user can have multiple devices (one per device where they are logged in).
The association is removed on logout — the device record persists with no
associated user (an "orphaned" device).

Operator scoping:
For operator-scoped tokens, only devices currently associated with a user
belonging to the token's operator are returned. Orphaned devices are excluded
because the operator that registered the device is no longer resolvable after
logout. Devices whose associated user has been soft-deleted ARE returned for
the operator they belonged to — the soft-deleted-user signal is preserved for
fraud-detection workflows. Applying filter[operatorId] follows the same rule.

Results are paginated using cursor-based pagination. By default they are
ordered by device ID descending (newest devices first); use the sort
parameter to override this order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
filter
object

Filters for user devices listing

string
enum

Sort the result set by a single field. Prefix the field name with - for
descending order; omit the prefix for ascending order.

Supported fields:

  • id — device ID
  • createdAt — creation timestamp
  • updatedAt — last update timestamp

Examples:

  • ?sort=createdAt — oldest devices first
  • ?sort=-createdAt — newest devices first

When omitted, results are ordered by device ID descending (newest first).

Allowed:
integer
1 to 100
Defaults to 100

The number of items to return per page.

string

The cursor to fetch the next page.

Do not construct this value manually. Use one of the following methods:

  • Use the value from the previous response's links.next to fetch the next page
  • Pass an empty string (e.g., ?cursor or ?cursor=) to initiate cursor pagination on the first page
Responses

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