Sign in

v1

latestOpenAPI 3.0.32026-07-2672165314.6 KB
Properties

Property info by Id

Get the basic info for a given property

get/v2/properties/{id}

Path parameters

idinteger required

Property identifier

Query parameters

widinteger

Optional website identifier for localized content

includeInOutboolean

If true, includes available dates for arrival or departure

Response

Success

idinteger

property identifier

namestring nullable

Name of the property

internal_namestring nullable

Internal name of property

descriptionstring nullable

Description of the property

latitudenumber double

Latitude coordinate of the house

longitudenumber double

Longitude coordinate of the house

addressstring nullable

Address of the property

hide_addressboolean

Owner requested to hide address from public

zipstring nullable

Zip code for the property

citystring nullable

City name where the property is located

statestring nullable

Region name where the property is located

country_codestring nullable

Two Letters Country Code where the property is located

countrystring nullable

Country name where the property is located

image_urlstring nullable

Image Url

has_addonsboolean

Boolean indicating if the property has available addons

has_agreementboolean
agreement_textstring nullable
agreement_urlstring nullable
ratingnumber double
price_unit_in_daysinteger

Price unit in days. This field indicates the number of days of stay the MinPrice and MaxPrice are So if we have a 30 PriceUnitInDays, it means the MinPrice and MaxPrice are Monthly prices If multiple prices per diferent periods are defined it will return daily prices

min_pricenumber double
original_min_pricenumber double
max_pricenumber double
original_max_pricenumber double
in_out_max_datestring date-time
currency_codestring nullable
created_atstring date-time

DateTime of creation

updated_atstring date-time

Last update datetime

is_activeboolean

Boolean indicating ig the property is active or not (meaning if is linked to a valid website)

subscription_plansstring[] nullable

Subscription plans