Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Query Parameters

after
string<uuid> | null

The next of the previous page.

kind
enum<string> | null

Only devices of this kind: personal, shared, kiosk or workstation. Who works on a device and how it was enrolled. Kiosks stay unavailable until badge sign-in ships, and workstations are paired by the scanner bridge.

Available options:
personal,
shared,
kiosk,
workstation
platform
enum<string> | null

Only devices on this platform: ios, ipados, android, macos, windows or linux. What a device runs, as the app reports it.

Available options:
ios,
ipados,
android,
macos,
windows,
linux
status
enum<string> | null

Only devices in this status: active, locked, wipe_pending, wiped or retired. Asking for retired lists them. Where a device stands. Every legal move is in canMoveTo(), so lock, wipe and retire all ask the same question.

Available options:
active,
locked,
wipe_pending,
wiped,
retired
location_id
string<uuid> | null

Only devices assigned to this location.

show_retired
boolean | null

Also list retired devices, which are left out otherwise.

Response

DevicePageResource

data
DevicePageResource · object
required