API Reference

Field Reference

type: The type of object returned; "room-type" indicates a single room type record.

data: Contains the full details of the room type object.


roomTypeId: Unique identifier for the room type used internally.

roomTypeName: Display name of the room type (e.g., "Unicorn").

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

description: Optional marketing or internal description of the room type.

bedroomCount: Total number of separate bedrooms in the room type.

bathroomCount: Total number of bathrooms included in the unit.

bedCount: Total number of beds in the room.

roomSize: Size of the room in square meters or feet; 0 if unspecified.

masterRate: Default base rate typically used for pricing reference or rate comparisons.

minRate: Minimum allowed nightly rate for this room type.

includedOccupancy: Number of guests included in the base rate.

maximumOccupancy: Maximum number of guests allowed in the room type.

isIndividualProperty: Boolean indicating if this is a standalone unit (e.g., a holiday house).

address: Physical address of the room/property (blank if not set).

city: City where the room/property is located.

state: State or region of the location.

postCode: Postal code of the property.

country: Country of the room type.

lat: Latitude for geolocation purposes; 0 if not set.

lng: Longitude for geolocation purposes; 0 if not set.


amenities: A list of amenity objects associated with the room type:

id: Internal identifier of the amenity (e.g., "air-con").

label: Display name of the amenity (can be empty if not populated).


allowChildren: Boolean indicating whether children are allowed to stay in this room type.

allowEvent: Boolean indicating whether the room can be booked for events.

allowPets: Boolean indicating whether pets are permitted.

allowSmoking: Boolean indicating whether smoking is permitted.

licenseNumber: License number tied to the room type, if required by local regulations.


photos: A list of images associated with the room type:

id: Unique identifier for the image.

url: Publicly accessible URL for the photo.

caption: Optional caption or label for the image (may be empty).