API Reference
Start typing to search…

Query Property Availabilities

get https://api.hostex.io/v3/availabilities

By sending a request to this endpoint, you can retrieve the availabilities of the properties.

Query Params
string
required

Enter property IDs to search, separating them with commas (,). A maximum of 100 properties can be queried at once.

date
required

The start date for records. The date format is YYYY-MM-DD, and must be within 1 years from now.

date
required

The end date for records. The date format is YYYY-MM-DD, and must be within 3 years from now.

Response

Response body
object
string
required

Unique identifier for the request.

integer
required

Numeric error code representing the status of the response. A value of 200 indicates success.
See the Error Codes section for more information.

string
required

Message detailing the status of the response.

data
object
required
listings
array of objects
listings
object
integer
required

The unique identifier for the property

availabilities
array of objects
required

A list of availability objects. Each object contains the date, available, and remarks for that date.

availabilities*
object
date
required

The date of the availability

boolean
required

Set the date's availability: true for available or false for unavailable.

string
required

Remarks for the date

Updated about 1 year ago

Did this page help you?
Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?