Sign in

v3

latestOpenAPI 3.0.02026-07-3179137151.7 KB
Listings

Fetch a listing.

get/v2/listings/{id}

Path parameters

idinteger required

The Property ID of the listing to fetch.

Query parameters

descriptionFormat'html' | 'text'

The format to return for short and long descriptions.

Response

bathroom_countinteger

The number of bathrooms in this listing.

bathroom_full_countinteger

The number of "full" bathrooms in this listing.

bathroom_half_countinteger

The number of "half" bathrooms in this listing.

bedroom_countinteger

The number of bedrooms in this listing.

cancellation_policystring
check_in_instructionsstring

Check-in instructions for the listing. Can contain HTML.

directionsstring

Directions to the listing. Can contain HTML.

house_manualstring

House manual for the listing. Can contain HTML.

internet_infostring

Internet/Wifi details for the listing. Can contain HTML.

location_typesLocationTypeFeatures[]
nightly_rate_maxnumber nullable
nightly_rate_minnumber nullable
occupancy_maxinteger nullable

The maximum occupancy of this listing.

occupancy_mininteger

The minimum occupancy of this listing.

property_idinteger

The ID of the property to which this listing content pertains.

property_space_type'entire_home' | 'private_room' | 'shared_room'
registration_datestring date-time nullable
registration_numberstring
review_averagenumber
review_countinteger
sleeps_in_beds_countinteger nullable

The calculated maximum number of occupants this listing can fit into beds.

sleeps_maxinteger nullable
sleeps_mininteger nullable
wifi_networkstring

Wifi network name for internet access at the property.

wifi_passwordstring

Wifi network password for internet access at the property.