List devices

get

https://api.sensos.io/v1/accounts/{accountId}/devices

Fetch a list of devices based on various filter criteria. Results are ordered by last modification time, newest first; there is no sort parameter.

Path Params

accountId

string

required

The account ID associated with the devices.

Query Params

string

^[a-zA-Z0-9*]+$

Filter devices by ID. Not case sensitive. Supports wildcard (*) characters, e.g. *555232* (contains), 987231* (starts with).

name

string

^[a-zA-Z0-9*-]+$

Filter devices by name. Not case sensitive. Supports wildcard (*) characters.

setId

string

^[a-z0-9-]+$

Filter devices by set ID.

boxId

string

Filter devices by box ID (exact match).

status

string

enum

Filter devices by status.

Allowed:

connectivityStatus

string

enum

Filter devices by connectivity status.

Allowed:

cursor

string

Opaque pagination cursor returned as metadata.nextCursor by the previous page. Cursors expire after 2 days; an invalid or expired cursor returns 400 Bad Request.

limit

int32

≤ 100

Defaults to 50

Maximum number of devices to return. Values outside 1-100 are clamped (0 or less uses the default of 50; more than 100 uses 100).

includeTotal

boolean

Defaults to false

Include the total number of matching devices in metadata.total.

Responses

401

Unauthorized. The access token is missing, invalid or expired. Returned by the gateway with an empty body.

403

Forbidden. The caller lacks permission, or the account is unknown, belongs to another tenant or is inactive. Returned by the gateway with an empty body.

200Success

400Bad Request. A filter or paging parameter is invalid (including an invalid or expired cursor).