Sign in
Listings

Query for a pageable list of property listings.

get/v2/listings

Query parameters

includeAmenitiesboolean

Include amenities collections on results.

includeRoomsboolean

Include rooms collection on results.

includeBathroomsboolean

Include bathrooms collection on results.

includeImagesboolean

Include images collection on results.

includeDescriptions'html' | 'text'

Include descriptions on results. The specified format (HTML or Text) is applied to Short Description and Long Description.

Response

limitinteger

The maximum number of records per page.

next_page_urlstring

URL to fetch the next page of records. A null value indicates that there are no more pages in the collection.

offsetinteger

The current offset from the start of the collection.

Changes

Changed in 1 of the 7 revisions of this API.1