Skip to main content
GET
List devices

Updated 23 Oct 2026 15:20 · page 020f3f8

Authorizations

Authorization
string
header
required

Mint a token from the portal at Settings → API tokens. Send it as Authorization: Bearer avb_... on every request. Query-string tokens are NOT accepted — the URL ends up in access logs.

Query Parameters

building_id
string<uuid>

Restrict results to one building.

room_id
string<uuid>

Restrict results to one room.

status
enum<string>

Exact match on latest known status.

Available options:
online,
offline,
unknown,
switched_off
firmware_status
enum<string>

Only devices whose firmware has this status against its target. differs_from_target lists the devices to update.

Available options:
matches_target,
differs_from_target,
no_target,
not_reported
limit
integer
default:100

Rows per page. Default 100, maximum 500.

Required range: 1 <= x <= 500
cursor
string

Opaque pagination cursor from a previous response's next_cursor. Omit on the first call. Treat this as an opaque string — its shape may change.

Response

Page of devices.

data
object[]
required
next_cursor
string | null
required

Pass this back as ?cursor= on the next call. null means this page is the last one.