Sign in

v3

latestOpenAPI 3.0.02026-07-3179137151.7 KB
Properties

Fetch a property.

get/v2/properties/{id}

Path parameters

idinteger required

The property unqiue Id.

Response

A model representing the property.

idinteger

The ID of this record.

tagsstring[]

A collection of tag names.

activeboolean

The property status.

bathroomsinteger

The total number of full and half bathrooms at this property.

bathrooms_fullinteger

The number of full bathrooms at this property.

bathrooms_halfinteger

The number of half bathrooms at this property.

bedroomsinteger

The number of bedrooms at this property.

check_instring

Check-in Start time rule for the property (hh:mm formatted).

check_in_endstring

Check-in End time rule for the property (hh:mm formatted).

check_outstring

Check-out time rule for the property (hh:mm formatted).

currency_codestring

The currency used for transactions by this property.

display_orderinteger nullable

The internal property display order.

external_display_orderinteger nullable

The external property display order.

external_namestring

The external property display name.

internal_codestring

The internal property identification code.

is_snoozedboolean

Whether the property is snoozed.

keystring guid

A globally unique ID for this property.

latitudenumber nullable

The property latitude.

listing_numbersobject

The collection of listing sites and the associated account token.

living_areainteger nullable

The numerical value for the living area of this property.

living_area_typestring

The unit type for living area, either sq. ft. or m².

longitudenumber nullable

The property longitude.

max_adultsinteger nullable

The max number of adults allowed at this property, null to use max guests.

max_childreninteger nullable

The max number of children allowed at this property, null to use max guests and 0 if not allowed.

max_guestsinteger

The max number of guests allowed at this property.

max_petsinteger nullable

The max number of pets allowed at this property, null for any number and 0 if not allowed.

namestring

The internal property display name.

owner_idinteger nullable

The property owner id.

property_type'apartment' | 'barn' | 'boat' | 'bungalow' | 'cabin' | 'castle' | 'chalet' | 'chateau' | 'condo' | 'cottage' | 'estate' | 'farmhouse' | 'hotel' | 'house' | 'house_boat' | 'lodge' | 'mill' | 'mobile_home' | 'recreational_vehicle' | 'studio' | 'tower' | 'townhome' | 'villa' | 'yacht' | 'bed_and_breakfast' | 'building' | 'campground' | 'caravan' | 'chacara' | 'corporate_apartment' | 'guest_house' | 'hostel' | 'mas' | 'resort' | 'riad' | 'suite' | 'beach_hut' | 'boathouse' | 'cave_house' | 'converted_chapel' | 'finca' | 'fort' | 'gite' | 'hotel_apartment' | 'light_house' | 'log_cabin' | 'manor_house' | 'narrowboat' | 'pent_house' | 'room' | 'shepherds_hut' | 'ski_chalet' | 'tent' | 'tipi' | 'tree_house' | 'trullo' | 'watermill' | 'windmill' | 'yurt' | 'aparthotel' | 'boutique_hotel' | 'casa_particular' | 'cycladic_house' | 'dammuso' | 'dome_house' | 'earthhouse' | 'farmstay' | 'guest_suite' | 'heritage_hotel' | 'hut' | 'igloo' | 'island' | 'loft' | 'minsu' | 'pension' | 'plane' | 'ryokan' | 'serviced_apartment' | 'tiny_house' | 'train' | 'ranch' | 'holiday_park' | 'religious_building' | 'shipping_container' | 'kezhan' | 'pousada' | 'camping' | 'inn' | 'motel' | 'homestay' | 'holiday_home' | 'country_house'
public_urlstring

The public property website URL.

thumbnail_urlstring

A small thumbnail photo for this property.

thumbnail_url_largestring

A large thumbnail photo for this property.

thumbnail_url_mediumstring

A medium thumbnail photo for this property.

time_zonestring

The property's time zone in IANA Time Zone format. If null, the user's time zone should be used as a fallback.