Skip to main content

Property

The Property entity holds details about individual property, primarily focusing on the room type data, units present in each room type.

Fields​

FieldTypeDescription
idstring/numberIdentifier of the Property
createdAtstringDate and time when the entry was created in ISO 8601 format.
updatedAtstringDate and time when the entry was last updated in ISO 8601 format.
namestringName of the Property
internalNamestringInternal name used for identification.
descriptionstringDescription of the property
typestringType of the Property.
statusstringStatus of the Property.
thumbnailUrlstringURL of the thumbnail image.
addressobjectAddress details of the property.
geoLocationobjectGeographical coordinates of the property.
startPricenumberStarting price for the property.
currencystringCurrency used for pricing.
timeZonestringTime zone of the property location.
ratingobjectRating details of the property.
roomTypesobjectRoom type details associated with the property.

Sub Fields​

Address​

FieldTypeDescription
line1stringThe first line of the address.
line2stringThe second line of the address (if any).
postal_codestringThe postal or ZIP code for the address.
citystringThe city where the address is located.
statestringThe state or province of the address.
countrystringThe country where the address is located.

GeoLocation​

FieldTypeDescription
latitudenumberLatitude of the property.
longitudenumberLongitude of the property.

Rating​

FieldTypeDescription
averagenumberAverage rating of the property.
countnumberTotal number of ratings for the property.

RoomTypes​

FieldTypeDescription
idstring/numberUnique Identifier of the Room type.
namestringName of the Room type.

Supported fields in each source system​

FieldHostawayHostifySmoobuLodgifyUplistingGuestyHostfullyOwnerRezBeds24HospitableFantasticStayHostexElinaBookingSyncDirectYour RentalsMr AlfredReslyRentalWiseCloudbedsZeevou
id✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅
createdAt✅--✅✅✅-------✅-✅--✅-✅
updatedAt✅✅-✅-✅✅---✅--✅✅✅--✅-✅
name✅✅✅✅✅✅✅✅✅✅✅-✅✅✅✅✅✅✅✅✅
internalName✅✅--✅✅✅-✅-✅✅✅✅✅✅✅-✅-✅
description✅✅-✅✅✅✅✅✅✅✅-✅✅✅✅✅✅✅✅✅
type✅✅✅-✅✅✅✅✅-🔜--✅✅✅✅-✅✅✅
status🔜✅---✅🔜✅-✅✅---✅✅✅✅✅-✅
thumbnailUrl✅✅-✅-✅✅✅--✅✅--✅✅✅✅✅✅✅
address✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅🔶✅✅
geoLocation✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅
startPrice✅✅✅✅✅✅✅✅--✅--✅-✅✅✅--✅
currency✅✅✅✅✅✅✅✅✅✅✅--✅✅✅✅-✅✅✅
timeZone✅✅✅-✅✅---✅✅--✅-✅✅--✅✅
rating✅✅-✅-✅-✅--✅--✅----✅-✅
roomTypes✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅

✅ Supported and mapped
🔶 Partially mapped, not exact match
🔜 Launching soon
— Not supported in source system


Supported Methods in each source system​

MethodsHostawayHostifySmoobuLodgifyUplistingGuestyHostfullyOwnerRezBeds24HospitableFantasticStayHostexElinaBookingSyncDirectYour RentalsMr AlfredReslyRentalWiseCloudbedsZeevou
Get All Properties✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅

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.