LogoDocumentation

Devices

devices

Methods

List Devices -> OffsetPage<
Device
>
get/devices

Retrieve a list of devices.

Filtering by custom properties

Use the query parameter to filter devices on custom properties. Syntax:

  • properties.key:value: matches devices with a property that contains a key named key with a value of value; use double quotes if the value contains spaces or special characters
  • properties.key:value1,value2: matches devices with a property that contains a key named key and its value is either value1 or value2
  • properties.key:*: matches devices with a property that contains a key named key and any value
  • foo: matches devices with properties where any key or stringified value contains foo Multiple qualifiers can be used in the same query string; this will filter devices matching the intersection of the qualifiers (AND).
Create A Device ->
Device
post/devices

Create a device

Get A Device ->
Device
get/devices/{nameOrId}

Get details on a specific device.

Delete A Device -> { id }
delete/devices/{nameOrId}

Delete a device. Once a device is deleted, it will no longer show up in your list of devices.

Before deleting a device, you must delete all associated data.

Update A Device ->
Device
patch/devices/{nameOrId}

Update a device

path Parameters
nameOrId: string
Response fields
Device
Request example
200Example

Domain types

Device = { id, name, createdAt, 4 more... }
Devices

Tokens

devices.tokens

Methods

List Device Tokens -> Array<
DeviceToken
>
get/device-tokens

List device tokens

Create A Device Token ->
DeviceToken
post/device-tokens

You must have an Enterprise or Team account to create and use device tokens

Get A Device Token ->
DeviceToken
get/device-tokens/{id}

Get a device token

Edit A Device Token ->
DeviceToken
patch/device-tokens/{id}

Edit a device token

Delete A Device Token -> { id }
delete/device-tokens/{id}

Delete a device token

Domain types

DeviceToken = { id, createdAt, deviceId, 1 more... }

A DeviceToken authenticates device agents to the API.