Room Types
The Room Types entity holds details about room-type(s) of a property including room information, number of units, amenities, property details and custom fields.
Fields​
| Field | Type | Description |
|---|---|---|
| id | string/number | Identifier of the Room type |
| propertyId | string/number | Identifier of the property associated with a Room type |
| createdAt | string | Date and time when the entry was created in ISO 8601 format |
| updatedAt | string | Date and time when the entry was last updated in ISO 8601 format |
| name | string | Name of the Room type |
| description | string | Description of the Room type |
| thumbnailUrl | string | URL of the thumbnail image |
| pictures | string[] | Picture URLs of the Room type and their descriptions |
| units | object | Unit related details of the associated room type |
| maximumNights | number | Default maximum number of nights for booking the room type |
| minimumNights | number | Default minimum number of nights for booking the room type |
| maxOccupancy | number | Maximum occupancy of the room type |
| startPrice | number | Starting price for the room type |
| bedRoom | object | Bedroom details of the room type |
| bathRoom | object | Bathroom details of the room type |
| rooms | object | Details about rooms of the room type |
| checkIn | object | Check-in details of the room type |
| checkOut | object | Check-out details of the room type |
| wifiDetails | object | Wifi details of the room type |
| amenities | object | Amenities of the room type |
| roomTypeDetails | object | Details about the room type |
| agreements | object | Agreements related to the room type |
| contact | object | Contact information of the property manager or host |
| policy | object | Policies of the room type |
| channels | object | Channels where this room type is listed |
| others | object | Miscellaneous details of the room type |
| customFields | object | Custom fields of the room type |
Sub Fields​
units​
| Field | Type | Description |
|---|---|---|
| count | number | No. of units within the room type. |
| data.id | string/number | Identifier of the unit. |
| data.name | string | Name of the unit. |
| data.description | string | Description of the unit. |
| data.maxOccupancy | number | Maximum occupancy of the unit. |
bedRoom​
| Field | Type | Description |
|---|---|---|
| type | string | Type of the bedroom. |
| count | number | Number of bedrooms. |
| bedsCount | number | Number of beds in the bedroom. |
bathRoom​
| Field | Type | Description |
|---|---|---|
| type | string | Type of the bathroom. |
| count | number | Number of bathrooms. |
rooms​
| Field | Type | Description |
|---|---|---|
| id | string/number | Identifier of the room. |
| name | string | Name of the room. |
| type | string | Type of the room. |
| roomNumber | number | Room number. |
| maxOccupancy | number | Maximum occupancy of the room. |
| beds.id | string/number | Identifier of the bed in the room. |
| beds.name | string | Name of the bed. |
| beds.type | string | Type of the bed. |
| beds.count | number | Number of beds in the room. |
checkIn​
| Field | Type | Description |
|---|---|---|
| checkInStart | string | Start time for check-in in HH:MM:SS format. Local time is passed as it is from the PMS without transformation. |
| checkInEnd | string | End time for check-in in HH:MM:SS format. Local time is passed as it is from the PMS without transformation. |
| checkInInstructions | string | Instructions for check-in. |
| checkInType | string | Type of check-in. |
| checkInDescription | string | Description of check-in. |
| checkInPlace | string | Place for check-in. |
checkOut​
| Field | Type | Description |
|---|---|---|
| checkOutStart | string | Start time for check-out in HH:MM:SS format. Local time is passed as it is from the PMS without transformation. |
| checkOutEnd | string | End time for check-out in HH:MM:SS format. Local time is passed as it is from the PMS without transformation. |
| checkOutInstructions | string | Instructions for check-out. |
| checkOutType | string | Type of check-out. |
| checkOutDescription | string | Description of check-out. |
| checkOutPlace | string | Place for check-out. |
wifiDetails​
| Field | Type | Description |
|---|---|---|
| type | string | Type of wifi. |
| ssid | string | SSID of the wifi. |
| password | string | Password for the wifi. |
amenities​
| Field | Type | Description |
|---|---|---|
| id | string/number | Identifier of the amenity. |
| name | string | Name of the amenity. |
| description | string | Description of the amenity. |
| type | string | Type of the amenity. |
roomTypeDetails​
| Field | Type | Description |
|---|---|---|
| directions | string | Directions to the room type. |
| manual | string | Manual for the room type. |
| instructions | string | Instructions for the room type. |
| rules | string | Rules for the room type. |
| notes | string | Notes for the room type. |
| space | string | Space details of the room type. |
| access | string | Access details of the room type. |
| interaction | string | Interaction details of the room type. |
| neighborhood | string | Neighborhood details of the room type. |
| transit | string | Transit details of the room type. |
| other | string | Other details of the room type. |
Agreements​
| Field | Type | Description |
|---|---|---|
| isActive | boolean | Indicates if the agreement is active. |
| id | string | Identifier of the agreement. |
| description | string | Description of the agreement. |
Contact​
| Field | Type | Description |
|---|---|---|
| name | string | Name of the contact. |
| firstName | string | First name of the contact. |
| lastName | string | Last name of the contact. |
| string[] | Array of email addresses. | |
| phone | string[] | Array of phone numbers. |
| address | string | Address of the contact. |
| language | string | Language of the contact. |
| country | string | Country of the contact. |
Channels​
| Field | Type | Description |
|---|---|---|
| channelName | string | Name of the channel. |
| channelListingId | string | Listing ID in the channel. |
| channelListingUrl | string | Listing URL in the channel. |
policy​
| Field | Type | Description |
|---|---|---|
| generalPolicy | string | General policy of the room type. |
| privacyPolicy | string | Privacy policies of the room type. |
| cancellationPolicy | object | Cancellation policy of the room type. |
| securityDeposit | number | Security deposit details of the room type. |
| payment | number | Payment details of the room type. |
CustomField​
| Field | Type | Description |
|---|---|---|
| id | string | Identifier of the custom field. |
| name | string | Name of the custom field. |
| type | string | Type of the custom field. |
| value | string | Value of the custom field. |
| defaultValue | string | Default value of the custom field. |
Supported fields in each source system​
| Field | Hostaway | Hostify | Smoobu | Lodgify | Uplisting | Guesty | Hostfully | OwnerRez | Beds24 | Hospitable | FantasticStay | Hostex | Elina | BookingSync | Direct | Your Rentals | Mr Alfred | Resly | RentalWise | Cloudbeds | Zeevou | RMS Cloud | Streamline | Apaleo | Avantio | Tokeet | Track | Mews |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| propertyId | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| createdAt | ✅ | - | - | ✅ | ✅ | ✅ | - | - | - | - | - | - | - | ✅ | - | ✅ | - | - | ✅ | - | ✅ | - | ✅ | ✅ | - | ✅ | ✅ | - |
| updatedAt | ✅ | ✅ | - | ✅ | - | ✅ | ✅ | - | - | - | ✅ | - | - | ✅ | ✅ | ✅ | - | - | ✅ | - | ✅ | - | - | - | - | ✅ | ✅ | - |
| name | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| description | ✅ | ✅ | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| thumbnailUrl | ✅ | ✅ | - | ✅ | - | ✅ | ✅ | ✅ | - | - | ✅ | ✅ | - | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - | - | ✅ | ✅ | ✅ |
| pictures | ✅ | ✅ | - | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | ✅ | - | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | ✅ | ✅ | ✅ |
| bedRoom | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - | 🔶 | ✅ | ✅ | - |
| bathRoom | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - | 🔶 | ✅ | ✅ | - |
| maximumNights | ✅ | ✅ | - | - | - | ✅ | ✅ | - | - | - | ✅ | - | - | - | - | ✅ | - | - | - | - | - | - | ✅ | - | - | - | ✅ | - |
| minimumNights | ✅ | ✅ | - | - | - | ✅ | ✅ | - | - | - | ✅ | - | - | ✅ | - | ✅ | - | - | - | - | - | - | ✅ | - | - | - | ✅ | - |
| maxOccupancy | ✅ | ✅ | 🔜 | ✅ | ✅ | ✅ | ✅ | ✅ | - | - | ✅ | - | ✅ | ✅ | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| startPrice | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - | - | ✅ | - | - | ✅ | - | ✅ | ✅ | ✅ | - | - | ✅ | ✅ | - | - | - | - | ✅ | - |
| units | 🔶 | - | - | ✅ | _ | - | - | - | ✅ | - | - | - | ✅ | - | ✅ | - | - | - | 🔜 | ✅ | ✅ | ✅ | ✅ | ✅ | 🔶 | ✅ | ✅ | ✅ |
| rooms | ✅ | ✅ | - | ✅ | - | ✅ | ✅ | ✅ | 🔜 | ✅ | ✅ | - | - | ✅ | ✅ | ✅ | - | - | ✅ | - | ✅ | - | - | - | - | ✅ | ✅ | ✅ |
| channels | ✅ | ✅ | - | - | - | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | - | ✅ | - | - | - | - | - | - | ✅ | - | - | - | - | ✅ | ✅ | ✅ |
| checkIn | ✅ | ✅ | - | ✅ | ✅ | ✅ | ✅ | 🔶 | ✅ | ✅ | ✅ | - | - | ✅ | - | ✅ | ✅ | 🔶 | ✅ | ✅ | ✅ | ✅ | ✅ | - | - | ✅ | ✅ | - |
| checkOut | ✅ | ✅ | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | - | - | ✅ | - | ✅ | ✅ | 🔶 | ✅ | ✅ | ✅ | ✅ | ✅ | - | - | ✅ | ✅ | - |
| wifiDetails | ✅ | ✅ | - | - | - | ✅ | ✅ | ✅ | - | - | ✅ | - | - | - | - | - | ✅ | ✅ | - | - | ✅ | - | ✅ | - | ✅ | ✅ | ✅ | - |
| amenities | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | - | ✅ | ✅ | ✅ | 🔶 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | ✅ | ✅ |
| roomTypeDetails | ✅ | 🔶 | - | 🔶 | - | ✅ | ✅ | 🔶 | - | 🔶 | 🔶 | - | 🔶 | 🔶 | - | 🔶 | 🔶 | 🔶 | 🔶 | 🔶 | 🔶 | 🔶 | 🔶 | - | 🔶 | ✅ | ✅ | ✅ |
| agreements | ✅ | - | - | ✅ | - | - | - | - | 🔶 | - | - | - | - | 🔶 | - | - | - | - | - | - | - | - | - | - | - | - | ✅ | - |
| contact | ✅ | ✅ | - | - | - | ✅ | 🔜 | 🔜 | ✅ | ✅ | ✅ | - | 🔜 | ✅ | 🔜 | 🔶 | - | - | - | ✅ | - | ✅ | - | - | ✅ | ✅ | ✅ | - |
| license | ✅ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✅ | ✅ | 🔶 | 🔶 | - | - | - | - | - | - | - | ✅ | - |
| policy | 🔜 | 🔶 | - | - | 🔶 | ✅ | 🔶 | ✅ | ✅ | - | 🔶 | - | - | 🔶 | - | - | ✅ | - | - | 🔶 | - | ✅ | - | 🔶 | - | ✅ | ✅ | - |
| others | ✅ | ✅ | - | - | 🔜 | ✅ | ✅ | - | - | - | ✅ | - | - | - | - | ✅ | ✅ | - | - | - | - | - | - | - | - | - | ✅ | - |
| customFields | ✅ | ✅ | ✅ | - | - | ✅ | ✅ | ✅ | 🔜 | - | ✅ | - | ✅ | - | - | ✅ | - | - | 🔜 | - | 🔜 | - | ✅ | - | - | ✅ | ✅ | - |
✅ Supported and mapped
🔶 Partially mapped, not exact match
🔜 Launching soon
— Not supported in source system
Supported Methods in each source system​
| Methods | Hostaway | Hostify | Smoobu | Lodgify | Uplisting | Guesty | Hostfully | OwnerRez | Beds24 | Hospitable | FantasticStay | Hostex | Elina | BookingSync | Direct | Your Rentals | Mr Alfred | Resly | RentalWise | Cloudbeds | Zeevou | RMS Cloud | Streamline | Apaleo | Avantio | Tokeet | Track | Mews |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Get Room Types of Property | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Note: This table is applicable only if you're using our Realtime APIs (Base APIs). If the Cached Database add-on is enabled in your workspace, all endpoints will be accessible across all PMS systems.