v1

latestOpenAPI 3.0.02026-07-26866217.8 KB

Reviews

Query Reviews

Query reviews like the Reviews Page.

get/reviews

Query parameters

reservation_codestring

Filters the results by the specified reservation code.

property_idinteger

Filters the results by the specified property ID.

review_status'pending_guest_review' | 'pending_host_review' | 'reviewed'

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

start_check_out_datestring date

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

end_check_out_datestring 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

offsetinteger required

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

limitinteger required

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

Response

request_idstring required

Unique identifier for the request.

error_codeinteger required

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

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}