Devices API Reference
Enterprise API endpoints for managing devices.
List devices on this account
/devicesQuery Parameters
| Parameter | In | Required |
|---|---|---|
| type | query | No |
| search | query | No |
| expand | query | No |
| limit | query | No |
| cursor | query | No |
| sort | query | No |
Request Example
Responses
OK.
Query/body validation failure.
Unauthorized, invalid or expired authorization token
Forbidden. One of: (1) the token is valid but lacks the required scope for this endpoint (no body); (2) the OAuth client's access has been revoked ('{error: "The user has revoked access for this application..."}'). Never returned on the API-key auth path, which does not check scope at all.
No example response recorded for this status code.
Example response — 402-account-suspended:
Example response — 402-trial-ended:
No example response recorded for this status code.
Get a single device
/devices/{id}Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Request Example
Responses
OK.
Unauthorized, invalid or expired authorization token
Forbidden. One of: (1) the token is valid but lacks the required scope for this endpoint (no body); (2) the OAuth client's access has been revoked ('{error: "The user has revoked access for this application..."}'). Never returned on the API-key auth path, which does not check scope at all.
Device not found.
No example response recorded for this status code.
Example response — 402-account-suspended:
Example response — 402-trial-ended:
No example response recorded for this status code.
Get a G2 device's obfuscated admin key
/devices/{id}/admin-keyOnly supported for G2 devices — G3 devices keep their admin key encrypted server-side and are not readable via this route. The response is an obfuscated blob, uniquely keyed per device, that requires client-side decryption.
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Request Example
Responses
OK.
'unsupported.device.protocol' (not a G2 device), 'device.config.incomplete' (admin_key/password missing), or 'device.gmt_offset.not.configured'.
Unauthorized, invalid or expired authorization token
Forbidden. One of: (1) the token is valid but lacks the required scope for this endpoint (no body); (2) the OAuth client's access has been revoked ('{error: "The user has revoked access for this application..."}'). Never returned on the API-key auth path, which does not check scope at all.
Device not found.
'{message: "internal.server.error"}' — uncaught exception.
No example response recorded for this status code.
Example response — 402-account-suspended:
Example response — 402-trial-ended:
No example response recorded for this status code.