Sign in

v3

latestOpenAPI 3.0.02026-07-3179137151.7 KB
Properties

Fetch many properties.

get/v2/properties

Query parameters

payment_method_idinteger nullable

Filter by applicable payment method.

availability_start_datestring date-time nullable

Filter by availability start date.

availability_end_datestring date-time nullable

Filter by availability end date.

activeboolean nullable

Filter by status.

include_tagsboolean

Include tags collection on results.

include_fieldsboolean

Include fields collection on results.

include_listing_numbersboolean

Include listing numbers collection on results.

Response

A pageable list of property models.

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.