List rooms
Lists rooms across the current organization with optional property, status, search, archived, period, and pagination filters. When period is supplied, each room includes the canonical meter-reading completeness for that billing month.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter by property; all properties in the organization when omitted
Filter by room status
Occupancy+operational status as seen on the wire (ADR 0017). The four
values are stable for clients, but VACANT/OCCUPIED are now derived
from active-lease existence rather than stored; HIDDEN/MAINTENANCE are
the landlord-controlled operational override. Used for the room response
status, the ?status= list filter, and room-mutation requests.
VACANT, OCCUPIED, HIDDEN, MAINTENANCE Case-insensitive match on room name or floor
120Include archived rooms (default false)
Optional billing period in YYYY-MM. When supplied, each room includes meter_reading_status and meter_reading_id for that period.
7^\d{4}-\d{2}$Page size 1-500 (default 100)
1 <= x <= 500Page offset (default 0)
x >= 0Response
Organization rooms
Endpoint-specific response payload. See the referenced schema for the resource fields.
Request correlation identifier returned from X-Request-Id or generated by the API.
Optional response metadata such as pagination limits, counts, or export context.