Review data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | unique identifier for the review |
created_at | string (date-time) | No | when the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | when the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
listing_id | string | No | pointer to the Property Listing that was reviewed |
reservation_id | string | No | pointer to the Property Reservation that was reviewed |
guest_id | string | No | pointer to the Property Guest who wrote the review |
author_name | string | No | the reviewer name |
source | string | No | the channel the review was posted on, eg. Airbnb |
title | string | No | the review title |
content | string | No | the review text |
rating | number | No | the overall rating |
category_ratings | PropertyCategoryrating[] | No | ratings per category |
category_ratings[].category | enum | No | the rated category Values: CLEANLINESS, ACCURACY, COMMUNICATION, CHECKIN, LOCATION, VALUE, OTHER |
category_ratings[].rating | number | No | the category rating |
category_ratings[].comment | string | No | the guest comment for this category |
private_feedback | string | No | private feedback for the host |
response | string | No | the host public reply |
responded_at | string (date-time) | No | when the host replied (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
is_public | boolean | No | whether the review is publicly visible |
metadata | PropertyMetadata[] | No | custom field values |
metadata[].id | string | No | the custom field identifier |
metadata[].slug | string | No | the custom field key |
metadata[].value | object | No | the custom field value |
metadata[].namespace | string | No | the scope or origin of the custom field |
metadata[].format | enum | No | the data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | additional data about the custom field |
Are we missing anything? Let us know
Was this page helpful?