API Reference

Field Reference

type: Specifies the object type; always "rooms" for this endpoint.

count: The number of room records included in the data array.

data: An array of room objects, each representing a single room/unit.


roomId: Unique identifier for the room within the property.

roomName: Display name or label assigned to the room (used in UI and reporting).

status: Operational status of the room (e.g., active, inactive, empty).

statusHoliday: Availability status specifically for holiday letting (e.g., active, inactive).

statusTenancy: Boolean indicating whether the room is part of a long-term tenancy.

roomTypeId: Identifier for the room type associated with this room.

roomTypeName: Display name of the associated room type.

phoneExtension: Internal phone extension number for the room (if any).

phone: Full phone number assigned to the room (if applicable).

housekeepingStatus: Current housekeeping status of the room (e.g., clean, dirty, ready).

carpark: Carpark or parking bay number assigned to the room (if applicable).

notes: General notes or comments about the room.

wifiNetwork: Wi-Fi network name (SSID) available in the room.

wifiPswd: Wi-Fi password for accessing the network.

checkInInstructions: Guest-facing instructions for checking into the room.

checkOutInstructions: Guest-facing instructions for checking out of the room.

notesInternal: Internal notes visible only to staff, often used for operational or admin information.

notesHousekeeping: Housekeeping-specific notes, such as cleaning reminders or setup instructions.

keyNumber: Key or access card number associated with the room.