Retrieve the list of available properties

Use this endpoint to retrieve availability offers. To receive offers from properties you are already partnered with you need to specify the check in and check out dates, number of adults and either geo coordinates and a radius to search into or directly a list of property ids.

Note: you need to pass either property_ids or both latitude and longitude to query for properties.

You can find more information in the Availability guide

Query Params
string
required

Date(YYYY-MM-DD)

string
required

Date(YYYY-MM-DD)

integer
Defaults to 1

Number of adults

integer
Defaults to 0

Number of children

number
-90 to 90

The Latitude

number
≥ -180

The Longitude

integer
Defaults to 2000

The search radius in meters(m)

property_ids
array of strings

List of property IDs to be included. When specified, only these properties will be included in the response. The maximum size of property id list is 50.

property_ids
negotiated_rate_plans
array of strings

Deprecated! List of negotiated rate plan ids to be included.

negotiated_rate_plans
string
Defaults to null

The corporate_profile_id can be used to fetch specific rates linked to a corporate.

integer
Defaults to 1

The total number of units required

integer
≥ 0
Defaults to 0

The returned page number

integer
1 to 50
Defaults to 10

Limits the number of properties that will be used to search for availability when searching with coordinates. In case of a search using property ids, page and limit are ignored

boolean
Defaults to false

If set to true returns only the cheapest price per property

boolean
Defaults to false

If set to true then each offer will contain the nightly price alongside the total price

string

The unit type

string

Represents the occupancy for a room. Format: occupancy=numberOfAdults-firstChildAge;nextChildAge

boolean
Defaults to false

If true, a rate plan with multiple payment modes will generate multiple offers using the same rate/unit combination

Headers
string
required

Type 'Bearer' and then your API Token

Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json