Skip to main content

List devices

GET 
/workspaces/:id/devices

Paginated device list (API-Spec sections 4–5). Repeatable filter query params use the form field:op:value. Soft-deleted devices are excluded by default; use filter=status:eq:deleted (or include deleted in status:in) to list them. Filters (allowlist):

  • filter=status:eq:active — single status (active, disabled, deleted).
  • filter=status:in:active,disabled — any of the listed statuses.
  • filter=device_key:eq:my-device-1 — exact device_key in this workspace (same character rules as create).
  • filter=device_key:prefix:sensor- — keys starting with the prefix (substring match; at most one device_key filter per request).
  • filter=tags:eq:<key>=<value> — devices whose tags JSON object contains the key with the exact string value. Repeat the filter to require multiple tag pairs (AND). Example: filter=tags:eq:.energy_modem_visible=true. Sort: sort=created_at, sort=-updated_at, sort=device_key, sort=-last_seen_at, etc. Allowed fields: created_at, updated_at, device_key, last_seen_at. Default: -created_at. Include: include_custom_attributes=true embeds custom_attributes per device; when set, page_size is capped at 20.

Request​

Responses​

Paginated devices with optional embedded custom attributes.