Query Reviews

get

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

Query reviews like the Reviews Page.

Query Params

reservation_code

string

Filters the results by the specified reservation code.

property_id

integer

Filters the results by the specified property ID.

review_status

string

enum

Filters the results by the specified review status. Default: reviewed

Allowed:

start_check_out_date

date

Filters the results to include reservations with check-out dates starting from this date (inclusive). Default: 180 days ago.

end_check_out_date

date

Filters the results to include reservations with check-out dates up to this date (inclusive). Less than 180 days from start_check_out_date. Default: today

offset

integer

required

Defaults to 0

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

limit

integer

required

Defaults to 20

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

Response

200