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

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

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

Response body

object

request_id

string

required

Unique identifier for the request.

error_code

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.

error_msg

string

required

Message detailing the status of the response.

data

object

required

reviews

array of objects

required

List of the reviews

reviews*

object

reservation_code

string

required

The unique code identifying the reservation.

property_id

integer

required

The id of the property the reservation is associated with.

channel_type

string

required

The type of the channel. See Supported Channels for more information.

airbnb booking.com agoda expedia vrbo trip.com booking_site tujia_intl hostex_direct tujia xiaozhu meituan_bnb meituan_hotel muniao fliggy zhukeyun tiktok xiaohongshu ctrip houfy

listing_id

string

required

The unique identifier for different channels.
For example, the listing id for Airbnb is the Airbnb listing id, and the listing id for Booking.com is the Booking.com room id - rateplan id.

check_in_date

date

required

The check-in date of the reservation.

check_out_date

date

required

The check-out date of the reservation.

host_review

object | null

Reviews made by the host about the guest. Return null if the host has not made a review yet.

guest_review

object | null

Reviews made by the guest about their stay. Return null if the guest has not made a review yet.

host_reply

object | null

The host's reply to the guest's review. Return null if the host has not made a reply yet.