Skip to main content
GET
List rooms

Updated 23 Oct 2026 15:20 · page 6e30383

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.

tag
string

Only rooms with this room tag (its name, ignoring case). Tags are set on the Room tags page.

Response

Rooms.

id
string<uuid>
required
name
string
required
building_id
string<uuid>
required
building
string
required
tags
string[]
required

The room's tags, by name, set on the Room tags page. Empty when it has none.