Skip to main content

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​

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.
picturesArray of PictureArray containing picture URLs and their descriptions.
addressPropertyAddressAddress details of the property.
geoLocationobject GeoLocationGeographical coordinates of the property.
languagestringLanguage associated with the property.
maximumNightsnumberMaximum number of nights for stay.
minimumNightsnumberMinimum number of nights for stay.
maxOccupancynumberMaximum occupancy of the property.
startPricenumberStarting price for the property.
currencystringCurrency used for pricing.
timeZonestringTime zone of the property location.
ratingobject RatingRating details of the property.
roomsobject RoomDetails about rooms in the property.
checkInobject CheckInCheck-in details of the property.
checkOutobject CheckOutCheck-out details of the property.
wifiDetailsobject WifiWifi details of the property.
amenitiesArray of AmenityArray of amenities provided.
propertyDetailsobject PropertyDetailsDetails about the property.
agreementsobject AgreementsAgreements related to the property.
contactobject ContactContact information of the property manager or owner.
licenseobject LicenseLicense details for the property.
policyobject PropertyPolicyProperty policy of the property.
customFieldsobject CustomFieldsCustom fields for the property.

Sub Fields​

Picture​

FieldTypeDescription
urlstringURL of the picture.
descriptionstringDescription of the picture.

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.

Room​

FieldTypeDescription
bedroomobject <Bedroom>Details about the bedroom.
bathroomobject <Bathroom>Details about the bathroom.
roomsArray RoomsArray of rooms.

Rooms.Bedroom​

FieldTypeDescription
typestringType of the bedroom.
countnumberNumber of bedrooms.
bedsCountnumberNumber of beds in the bedroom.

Rooms.Bathroom​

FieldTypeDescription
typestringType of the bathroom.
countnumberNumber of bathrooms.

Rooms.Rooms​

FieldTypeDescription
idstringIdentifier of the room.
namestringName of the room.
typestringType of the room.
descriptionstringDescription of the room.
roomNumbernumberRoom number.
maxOccupancynumberMaximum occupancy of the room.
maximumNightsnumberMaximum nights for stay in the room.
minimumNightsnumberMinimum nights for stay in the room.
maxAdultsnumberMaximum adults allowed in the room.
maxChildrennumberMaximum children allowed in the room.
bedsArray RoomsBedsArray of beds in the room.

RoomsBeds​

FieldTypeDescription
idstringIdentifier of the bed.
namestringName of the bed.
typestringType of the bed.
sizenumberSize of the bed.
countnumberNumber of beds.

CheckIn​

FieldTypeDescription
checkInStartstringStart time for check-in.
checkInEndstringEnd time for check-in.
checkInInstructionsstringInstructions for check-in.
checkInTypestringType of check-in.
checkInDescriptionstringDescription of check-in.
checkInPlacestringPlace for check-in.

CheckOut​

FieldTypeDescription
checkOutStartstringStart time for check-out.
checkOutEndstringEnd time for check-out.
checkOutInstructionsstringInstructions for check-out.
checkOutTypestringType of check-out.
checkOutDescriptionstringDescription of check-out.
checkOutPlacestringPlace for check-out.

Wifi​

FieldTypeDescription
typestringType of wifi.
ssidstringSSID of the wifi.
passwordstringPassword for the wifi.

Amenity​

FieldTypeDescription
idstringIdentifier of the amenity.
namestringName of the amenity.
descriptionstringDescription of the amenity.
typestringType of the amenity.
amenitiesArrayArray of amenities.

PropertyDetails​

FieldTypeDescription
directionsstringDirections to the property.
manualstringManual for the property.
instructionsstringInstructions for the property.
rulesstringRules for the property.
notesstringNotes for the property.
spacestringSpace details of the property.
accessstringAccess details of the property.
interactionstringInteraction details of the property.
neighborhoodstringNeighborhood details of the property.
transitstringTransit details of the property.
otherstringOther details of the property.

Agreements​

FieldTypeDescription
isActivebooleanIndicates if the agreement is active.
idstringIdentifier of the agreement.
descriptionstringDescription of the agreement.

Contact​

FieldTypeDescription
namestringName of the contact.
firstNamestringFirst name of the contact.
lastNamestringLast name of the contact.
emailArrayArray of email addresses.
phoneArrayArray of phone numbers.
addressstringAddress of the contact.
languagestringLanguage of the contact.
countrystringCountry of the contact.

License​

FieldTypeDescription
numberstringLicense number.
typestringType of license.
issueDatestringDate of issue of the license.
expiryDatestringDate of expiry of the license.

PropertyPolicy​

FieldTypeDescription
generalPolicystringGeneral policy of the property.
cancellationPolicyObject text: string description: stringCancellation policy of the property.
securityDepositNumberSecurity deposit details of the property.
paymentNumberPayment details of the property.

CustomField​

FieldTypeDescription
idstringIdentifier of the custom field.
namestringName of the custom field.
typestringType of the custom field.
valuestringValue of the custom field.
defaultValuestringDefault value of the custom field.

Supported fields in each source system​

FieldHostawayHostifySmoobuLodgifyUplistingGuestyHostfullyOwnerRezBeds24HospitableFantasticStayHostexElinaBookingSync
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🔜🔶--🔶✅🔶✅✅-🔶--🔶
others✅✅--🔜✅✅---✅---
customFields✅✅✅--✅✅✅🔜-✅-✅-

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


Supported Methods in each source system​

MethodsHostawayHostifySmoobuLodgifyUplistingGuestyHostfullyOwnerRezBeds24HospitableFantasticStayHostexElinaBookingSync
Get Property✅✅✅✅✅✅✅✅✅✅✅✅✅✅
Get All Properties✅✅✅✅✅✅✅✅✅✅✅✅✅✅

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.000Z",
"checkInType": "smartlock",
"checkInPlace": "reception",
"checkInStart": "14:00:00.000Z",
"checkInInstructions": "Enter the provided access code on the smart lock."
},
"checkOut": {
"checkOutStart": "11:00:00.000Z"
},
"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": ""
}
]
}
}