Property

The Property entity holds details about individual listing, primarily focusing on the room's status, including occupancy, and its maintenance and cleaning states.

Fields

Field	Type	Description
id	string/number	Identifier of the Property
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 Property
internalName	string	Internal name used for identification.
description	string	Description of the property
type	string	Type of the Property.
status	string	Status of the Property.
thumbnailUrl	string	URL of the thumbnail image.
pictures	Array of Picture	Array containing picture URLs and their descriptions.
address	PropertyAddress	Address details of the property.
geoLocation	object GeoLocation	Geographical coordinates of the property.
language	string	Language associated with the property.
maximumNights	number	Maximum number of nights for stay.
minimumNights	number	Minimum number of nights for stay.
maxOccupancy	number	Maximum occupancy of the property.
startPrice	number	Starting price for the property.
currency	string	Currency used for pricing.
timeZone	string	Time zone of the property location.
rating	object Rating	Rating details of the property.
rooms	object Room	Details about rooms in the property.
checkIn	object CheckIn	Check-in details of the property.
checkOut	object CheckOut	Check-out details of the property.
wifiDetails	object Wifi	Wifi details of the property.
amenities	Array of Amenity	Array of amenities provided.
propertyDetails	object PropertyDetails	Details about the property.
agreements	object Agreements	Agreements related to the property.
contact	object Contact	Contact information of the property manager or owner.
license	object License	License details for the property.
policy	object PropertyPolicy	Property policy of the property.
channels	object	Channels where this property is listed.
customFields	object CustomFields	Custom fields for the property.

---

Sub Fields

Picture

Field	Type	Description
url	string	URL of the picture.
description	string	Description of the picture.

Address

Field	Type	Description
line1	string	The first line of the address.
line2	string	The second line of the address (if any).
postal_code	string	The postal or ZIP code for the address.
city	string	The city where the address is located.
state	string	The state or province of the address.
country	string	The country where the address is located.

GeoLocation

Field	Type	Description
latitude	number	Latitude of the property.
longitude	number	Longitude of the property.

Rating

Field	Type	Description
average	number	Average rating of the property.
count	number	Total number of ratings for the property.

Room

Field	Type	Description
bedroom	object <Bedroom>	Details about the bedroom.
bathroom	object <Bathroom>	Details about the bathroom.
rooms	Array Rooms	Array of rooms.

Rooms.Bedroom

Field	Type	Description
type	string	Type of the bedroom.
count	number	Number of bedrooms.
bedsCount	number	Number of beds in the bedroom.

Rooms.Bathroom

Field	Type	Description
type	string	Type of the bathroom.
count	number	Number of bathrooms.

Rooms.Rooms

Field	Type	Description
id	string	Identifier of the room.
name	string	Name of the room.
type	string	Type of the room.
description	string	Description of the room.
roomNumber	number	Room number.
maxOccupancy	number	Maximum occupancy of the room.
maximumNights	number	Maximum nights for stay in the room.
minimumNights	number	Minimum nights for stay in the room.
maxAdults	number	Maximum adults allowed in the room.
maxChildren	number	Maximum children allowed in the room.
beds	Array RoomsBeds	Array of beds in the room.

RoomsBeds

Field	Type	Description
id	string	Identifier of the bed.
name	string	Name of the bed.
type	string	Type of the bed.
size	number	Size of the bed.
count	number	Number of beds.

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.

Wifi

Field	Type	Description
type	string	Type of wifi.
ssid	string	SSID of the wifi.
password	string	Password for the wifi.

Amenity

Field	Type	Description
id	string	Identifier of the amenity.
name	string	Name of the amenity.
description	string	Description of the amenity.
type	string	Type of the amenity.
amenities	Array	Array of amenities.

PropertyDetails

Field	Type	Description
directions	string	Directions to the property.
manual	string	Manual for the property.
instructions	string	Instructions for the property.
rules	string	Rules for the property.
notes	string	Notes for the property.
space	string	Space details of the property.
access	string	Access details of the property.
interaction	string	Interaction details of the property.
neighborhood	string	Neighborhood details of the property.
transit	string	Transit details of the property.
other	string	Other details of the property.

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.
email	Array	Array of email addresses.
phone	Array	Array of phone numbers.
address	string	Address of the contact.
language	string	Language of the contact.
country	string	Country of the contact.

License

Field	Type	Description
number	string	License number.
type	string	Type of license.
issueDate	string	Date of issue of the license.
expiryDate	string	Date of expiry of the license.

PropertyPolicy

Field	Type	Description
generalPolicy	string	General policy of the property.
cancellationPolicy	Object text: string description: string	Cancellation policy of the property.
securityDeposit	Number	Security deposit details of the property.
payment	Number	Payment details of the property.

Channels

Field	Type	Description
channelName	string	Name of the channel.
channelListingId	string	Listing ID in the channel.
channelListingUrl	string	Listing URL in the channel.

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
id	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
createdAt	✅	-	-	✅	✅	✅	-	-	-	-	-	-	-	✅	-	✅	-	-	✅
updatedAt	✅	✅	-	✅	-	✅	✅	-	-	-	✅	-	-	✅	✅	✅	-	-	✅
name	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	-	✅	✅	✅	✅	✅	✅	✅
internalName	✅	✅	-	-	✅	✅	✅	-	✅	-	✅	✅	✅	✅	✅	✅	✅	-	✅
description	✅	✅	-	✅	✅	✅	✅	✅	✅	✅	✅	-	✅	✅	✅	✅	✅	✅	✅
type	✅	✅	✅	-	✅	✅	✅	✅	✅	-	🔜	-	-	✅	✅	✅	✅	-	✅
status	🔜	✅	-	-	-	✅	🔜	✅	-	✅	✅	-	-	-	✅	✅	✅	✅	✅
thumbnailUrl	✅	✅	-	✅	-	✅	✅	✅	-	-	✅	✅	-	-	✅	✅	✅	✅	✅
pictures	✅	✅	-	✅	✅	✅	✅	✅	-	✅	✅	-	-	✅	✅	✅	✅	✅	✅
address	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔶
geoLocation	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
language	✅	✅	-	✅	-	✅	✅	-	✅	-	✅	-	-	🔜	-	-	-	-	✅
maximumNights	✅	✅	-	-	-	✅	✅	-	-	-	✅	-	-	-	-	✅	-	-	-
minimumNights	✅	✅	-	-	-	✅	✅	-	-	-	✅	-	-	✅	-	✅	-	-	-
maxOccupancy	✅	✅	🔜	✅	✅	✅	✅	✅	-	-	✅	-	✅	✅	-	✅	✅	✅	✅
startPrice	✅	✅	✅	✅	✅	✅	✅	✅	-	-	✅	-	-	✅	-	✅	✅	✅	-
currency	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	-	-	✅	✅	✅	✅	-	✅
timeZone	✅	✅	✅	-	✅	✅	-	-	-	✅	✅	-	-	✅	-	✅	✅	-	-
rating	✅	✅	-	✅	-	✅	-	✅	-	-	✅	-	-	✅	-	-	-	-	✅
rooms	✅	🔶	✅	✅	✅	✅	🔶	✅	✅	🔶	🔶	-	🔶	✅	-	✅	🔶	🔶	✅
checkIn	✅	✅	-	✅	✅	✅	✅	🔶	✅	✅	✅	-	-	✅	-	✅	✅	🔶	✅
checkOut	✅	✅	-	✅	✅	✅	✅	✅	✅	-	✅	-	-	✅	-	✅	✅	🔶	✅
wifiDetails	✅	✅	-	-	-	✅	✅	✅	-	-	✅	-	-	-	-	-	✅	✅	-
amenities	✅	✅	✅	✅	✅	✅	✅	✅	✅	-	✅	-	✅	✅	✅	🔶	✅	✅	✅
propertyDetails	✅	🔶	-	🔶	-	✅	✅	🔶	-	🔶	🔶	-	🔜	🔶	-	🔶	🔶	🔶	🔶
agreements	✅	-	-	✅	-	-	-	-	🔶	-	-	-	-	🔶	-	-	-	-	-
contact	✅	✅	-	-	-	✅	🔜	🔜	✅	✅	✅	-	🔜	✅	🔜	🔶	-	-	-
license	✅	-	-	-	-	-	-	-	-	-	-	-	-	-	-	✅	✅	🔶	🔶
policy	🔜	🔶	-	-	🔶	✅	🔶	✅	✅	-	🔶	-	-	🔶	-	-	✅	-	-
channels	✅	🔜	🔜	🔜	🔜	🔜	🔶	🔜	🔜	✅	🔜	🔜	🔜	✅	🔜	🔜	🔜	🔜	-
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
Get Property	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	-	✅	✅	✅	✅	✅	✅	✅
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.

---

Sample Response

{
    "data": 
    {
        "id": "500008838",
        "updatedAt": "2024-02-09T22:10:03.000Z",
        "name": "Welcome to Home Away",
        "internalName": "La Lilla Resort",
        "description": "Welcome to your home away from home! Nestled in the heart of the city, our stylish and comfortable one-bedroom apartment is perfect for couples or solo travelers.",
        "type": "Apartment",
        "thumbnailUrl": "https://img.hostify.com/500000065/property/500176244-img-md.jpg",
        "pictures": [
            {
                "url": "https://img.hostify.com/500000065/property/500176244-img-md.jpg",
                "description": "Living room with modern furnishings and natural light"
            },
            {
                "url": "https://img.hostify.com/500000065/property/500176245-img-md.jpg",
                "description": "Fully equipped kitchen with stainless steel appliances"
            },
            {
                "url": "https://img.hostify.com/500000065/property/500176246-img-md.jpg",
                "description": "Cozy bedroom with king-sized bed and premium linens"
            },
            {
                "url": "https://img.hostify.com/500000065/property/500176247-img-md.jpg",
                "description": "Spacious bathroom with walk-in shower and toiletries"
            },
            {
                "url": "https://img.hostify.com/500000065/property/500176248-img-md.jpg",
                "description": "Private balcony with city views"
            }
        ],
        "address": {
            "city": "Bengaluru",
            "line1": "Sarjapur - Marathahalli Road ELAN HOMES",
            "state": "Karnataka",
            "country": "India",
            "postal_code": "560035"
        },
        "geoLocation": {
            "latitude": 12.9182479,
            "longitude": 77.6735165
        },
        "language": "en",
        "maximumNights": 30,
        "minimumNights": 1,
        "maxOccupancy": 4,
        "startPrice": 100,
        "currency": "USD",
        "timeZone": "Asia/Calcutta",
        "rating": {
            "average": 4.5
        },
        "rooms": {
            "bedroom": {
                "count": 2,
                "bedsCount": 2
            },
            "bathroom": {
                "count": 1.5
            },
            "rooms": [
                {
                    "id": "636e2bf4438cc100461de7d2",
                    "roomNumber": 1,
                    "beds": [
                        {
                        "id": "636e2bf4438cc100461de7d3",
                        "type": "QUEEN_BED",
                        "count": 1
                        }
                    ]
                },
                {
                    "id": "636e2bf4438cc100461de7d0",
                    "roomNumber": 2,
                    "beds": [
                        {
                        "id": "636e2bf4438cc100461de7d1",
                        "type": "QUEEN_BED",
                        "count": 1
                        }
                    ]
                }
            ]
        },
        "checkIn": {
            "checkInEnd": "15:00:00",
            "checkInType": "smartlock",
            "checkInPlace": "reception",
            "checkInStart": "14:00:00",
            "checkInInstructions": "Enter the provided access code on the smart lock."
        },
        "checkOut": {
            "checkOutStart": "11:00:00"
        },
        "wifiDetails": {
            "ssid": "LaLillaWifi",
            "type": "WPA2",
            "password": "password123"
        },
        "amenities": [
            {
                "id": 10,
                "name": "Essentials",
                "description": "Towels, bed sheets, soap, and toilet paper"
            },
            {
                "id": 3,
                "name": "Kitchen",
                "description": "Space where guests can cook their own meals"
            },
            {
                "id": 14,
                "name": "Hair dryer",
                "description": "Available in the bathroom"
            },
            
            {
                "id": 25,
                "name": "Refrigerator",
                "description": "Full-size refrigerator available"
            },
            {
                "id": 635,
                "name": "Life size games",
                "description": "Various board games available for entertainment"
            },
            {
                "id": 165,
                "name": "armchair",
                "description": "Comfortable armchair in the living area"
            }
        ],
        "propertyDetails": {
            "notes": "near lake.",
            "rules": "Please respect the property and the neighbors. No loud noises after 10 PM. No smoking inside.",
            "space": "The space is very clean and well-maintained. It includes a living room, kitchen, bedroom, and bathroom.",
            "access": "Guests have full access to the entire apartment and the amenities provided.",
            "manual": "A detailed house manual is provided upon check-in, including Wi-Fi instructions, appliance use, and local recommendations.",
            "transit": "Conveniently located with easy access to public transportation and main roads.",
            "directions": "Detailed directions to the property will be provided upon booking confirmation.",
            "interaction": "Host is available for any questions or assistance needed during your stay.",
            "neighborhood": "Located in a friendly and safe neighborhood with close proximity to shops, restaurants, and attractions."
        },
        "contact": {
            "name": "Ahadah a",
            "email": "ahadh@calry.ap",
            "phone": "123-456-7890"
        },
        "policy": {
            "securityDeposit": 200,
            "cancellationPolicy": {
            "text": "Full refund for cancellations made within 48 hours of booking, if the check-in date is at least 14 days away. 50% refund for cancellations made at least 7 days before check-in. No refund for cancellations made within 7 days of check-in."
            }
        },
        "customFields": [
            {
                "id": 300000060,
                "name": "Access Code",
                "type": "long_text",
                "value": "ABCD1234",
                "defaultValue": ""
            },
            {
                "id": 300000062,
                "name": "Property Code",
                "type": "number",
                "value": "0987654321",
                "defaultValue": ""
            }
        ]
    }
}