API Reference

Field Reference

type: The type of object returned by the API; always "room-types" for this endpoint.

count: Number of room type records included in the response.

data: An array containing room type objects.


roomTypeId: Unique identifier for the room type (used for backend references and linking).

roomTypeName: Display name of the room type, shown in UI and guest-facing interfaces.

status: Current operational status of the room type (e.g., active, inactive).

description: Short summary or marketing description of the room type.

bedroomCount: Number of separate bedrooms in the room type.

bathroomCount: Number of bathrooms included in the unit.

bedCount: Total number of beds available in the room.

roomSize: Size of the room in square meters or feet. 0 if not set.

masterRate: Default or base nightly rate used for pricing and benchmarking.

minRate: Minimum rate allowed for this room type (used in discounts or yield management).

includedOccupancy: Number of guests included in the base rate.

maximumOccupancy: Maximum number of guests allowed to stay in the room.

isIndividualProperty: Boolean indicating whether the room type represents a standalone property (e.g., a holiday home) rather than a unit in a complex.

address: Street address where the property or unit is located.

city: City of the room type’s location.

state: State or region of the location (e.g., QLD).

postCode: Postal code for the address.

country: Country code (e.g., AU for Australia).

lat: Latitude coordinate for map integration.

lng: Longitude coordinate for map integration.


amenities: Array of amenity objects associated with the room type. Each object includes:

id: Identifier for the amenity.

label: Human-readable name of the amenity (e.g., "Air Conditioning").


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

allowEvent: Boolean indicating whether events (e.g., parties) are allowed.

allowPets: Boolean indicating whether pets are allowed.

allowSmoking: Boolean indicating whether smoking is allowed.

licenseNumber: License number associated with this room type, if required by local authorities (blank if not set).


photos: Array of photo objects representing the room type. Each object contains:

id: Unique identifier for the image.

url: Public URL to the photo.

caption: Optional caption for the image (empty if not provided).