GET
List property rooms

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

property_id
string<uuid>
required

Property ID

Query Parameters

status
enum<string>

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.

Available options:
VACANT,
OCCUPIED,
HIDDEN,
MAINTENANCE

Case-insensitive match on room name or floor

Maximum string length: 120
include_archived
boolean

Include archived rooms (default false)

period
string

Optional billing period in YYYY-MM. When supplied, each room includes meter_reading_status and meter_reading_id for that period.

Required string length: 7
Pattern: ^\d{4}-\d{2}$
limit
integer<int64>

Page size 1-500 (default 100)

Required range: 1 <= x <= 500
offset
integer<int64>

Page offset (default 0)

Required range: x >= 0

Response

Rooms in property

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.