Params
| Name | Type | Requireness | Default value | Description |
|---|---|---|---|---|
| property_uids | string | optional | none | List of comma separated property UIDs. A property UID stands for the physical property and covers all of its connected channel listings |
| platform_type | string | optional | none | List of comma separated platform types (see the corresponding filters section). This filter returns guest reviews related to one of mentioned platform types |
| from_date | string | optional | none | YYYY-MM-DD Hide reviews submitted before this date |
| to_date | string | optional | none | YYYY-MM-DD Hide reviews submitted after this date (the date is included in the range) |
| rating | int | optional | none | Overall star rating from 1 to 5. This filter returns guest reviews whose overall rating rounds to this value |
| page | int | optional | 1 | Page number for pagination |
Description
List of guest reviews — reviews left by guests about their stay
This endpoint requires the following scope: messaging
Response sample
{
"data": [
{
"review_uid": "789456123_airbnb",
"platform_type": "airbnb",
"guest_uid": "456_airbnb",
"guest_name": "John Doe",
"booking_uid": "AXFNTT_airbnb_123",
"reservation_code": "AXFNTT",
"listing_uid": "1_airbnb_123",
"listing_name": "Cozy apartment in the city center",
"property_uid": "1482329366187",
"host_uid": "123_airbnb",
"review_date": "2019-01-14 20:15:00",
"public_review": "Great place, we loved our stay!",
"private_note": "The lock on the bathroom door is a bit loose",
"overall_rating": 5,
"category_ratings": {
"accuracy": 5,
"checkin": 5,
"cleanliness": 4,
"communication": 5,
"location": 5,
"value": 5
}
}
],
"meta": {
"page": 1,
"has_next_page": false
}
}
property_uidreferences the physical property, the same value the get-properties method returns.category_ratingsvalues arenullwhen the platform did not provide a rating for the category.