Skip to main content
GET
Get a device

Updated 23 Oct 2026 15:20 · page 3aa8e02

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.

Path Parameters

id
string<uuid>
required

Device id (UUID).

Response

Device detail.

id
string<uuid>
required
name
string
required

The device's display name. Falls back to the adapter's reported id when no override is set in the portal.

type
string
required

Device category: display, conferencing, audio, camera, control, avoip (AV-over-IP), power or projector.

protocol
string
required

The adapter the Collector uses for the device, e.g. sony_bravia, tesira, cisco_roomos, aten_pdu.

status
enum<string>
required

unknown when the device's Collector isn't reporting; switched_off while Room Readiness has it switched off for the night.

Available options:
online,
offline,
unknown,
switched_off
ip_address
string
make
string
model
string
serial_number
string
firmware_version
string

The device's firmware, as on the Firmware page: a firmware_version tag set in the portal, otherwise what the device last reported.

target_firmware_version
string

The target firmware set for the device's make and model on the Firmware page. Absent when none is set.

firmware_status
enum<string>

How the firmware compares with the target set for the device's make and model on the Firmware page: matches_target, differs_from_target, no_target (no target set) or not_reported (the device hasn't reported firmware).

Available options:
matches_target,
differs_from_target,
no_target,
not_reported
mac_address
string
room_id
string<uuid>
room
string
building_id
string<uuid>
building
string
last_seen_at
string<date-time> | null
tags
object
metrics
object

Adapter-specific latest-known metrics. Shape varies by adapter.