API Reference

Field Reference

type: Specifies the object type returned. Always "room" for this endpoint.

data: Contains the room details object.


roomId: Unique identifier for the individual room.

roomName: Display name or number of the room, used in UIs and reporting.

status: General operational status of the room (active or inactive).

statusHoliday: Availability status for holiday letting (active or inactive).

statusTenancy: Boolean indicating if the room is assigned to a long-term tenancy (true or false).

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

roomTypeName: Display name of the room type linked to this room.

phoneExtension: Phone extension number for the room, if applicable.

phone: Full phone number assigned to the room, if applicable.

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

carpark: Carpark or parking space associated with the room (empty if none).

notes: General notes about the room (visible across departments).

wifiNetwork: Wi-Fi SSID (network name) assigned to this room.

wifiPswd: Wi-Fi password for accessing the room’s network.

checkInInstructions: Instructions shown to guests for check-in.

checkOutInstructions: Instructions shown to guests for check-out.

notesInternal: Internal-only notes visible to staff (e.g., maintenance flags).

notesHousekeeping: Notes intended for housekeeping staff (e.g., linen requests).

keyNumber: Identifier for the physical key or keycard assigned to this room.