Sign in
PropertySearch

Search for properties.

get/v2/propertysearch

Query parameters

property_idsinteger[] nullable

Property ID's to filter, or null.

available_fromstring date-time nullable

Start of availability range to check, or null.

available_tostring date-time nullable

End of availability range to check, or null.

guests_mininteger nullable

Start of guest range to check, or null.

guests_maxinteger nullable

End of guest range to check, or null.

pets_allowedboolean nullable

Filter by pets allowed, or null.

children_allowedboolean nullable

Filter by children allowed, or null.

bedrooms_mininteger nullable

Start of bedrooms range to check, or null.

bedrooms_maxinteger nullable

End of bedrooms range to check, or null.

rate_minnumber nullable

Start of rate range to check, or null.

rate_maxnumber nullable

End of rate range to check, or null.

include_tag_idsinteger[] nullable

Tag IDs to include, or null.

exclude_tag_idsinteger[] nullable

Tag IDs to exclude, or null.

evaluate_rulesboolean nullable

If true, evaluate availability rules for otherwise matching properties and populate the RuleViolations list with any violations. Must also set available_from and available_to.

Response

A list of property id's and names.

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.

countinteger

The total number of records in the collection.

Changes

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

  • 00db66c441811See the full diff
    • ○

      api operation id PropertySearch_Get removed and replaced with get-propertysearch

      api-operation-id-removed