Query Reservations

get

https://api.hostex.io/v3/reservations

You can query reservations by making a request to this endpoint.

Query Params

reservation_code

string

Filters the results by the specified reservation code.

channel_id

string

Filters the results by the reservation ID in the channel (matches the channel_id field returned in the response).

property_id

integer

Filters the results by the specified property ID.

status

string

enum

Filters the results by the specified reservation status.

Allowed:

start_check_in_date

date

Filters the results to include reservations with check-in dates starting from this date (inclusive).

end_check_in_date

date

Filters the results to include reservations with check-in dates up to this date (inclusive).

start_check_out_date

date

Filters the results to include reservations with check-out dates starting from this date (inclusive). By default, reservations within 180 days are returned.

end_check_out_date

date

Filters the results to include reservations with check-out dates up to this date (inclusive).

order_by

string

enum

Defaults to booked_at

Sorts the results by the specified field (always descending). Default is booked_at. created_at sorts by the row creation timestamp (i.e. when the reservation was first synced into Hostex).

Allowed:

channel_type

string

enum

Filters the results by the specified channel type.

offset

integer

Defaults to 0

Specifies the starting index from which the results should be returned. Default: 0

limit

integer

Defaults to 20

Determines the maximum number of results to be returned, up to a maximum of 100. Default: 20.

Response

200