--- title: "Review data model" url: "https://docs.unified.to/property/review/model" description: "The Review data model object in Unified's Review API: 17 fields, including created_at, updated_at and listing_id, with types and enum values." date: "2026-10-29T08:41:27.988Z" updated: "2026-10-29T08:41:27.988Z" --- # Review data model Updated: October 29, 2026 View field support, webhooks, and list parameters for each integration on the [Supported Integrations](https://docs.unified.to/property/integrations.md) 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 | ## TypeScript ```typescript export type PropertyReview = { id?: string; // unique identifier for the review created_at?: string-time; // when the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) updated_at?: string-time; // when the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) listing_id?: string; // pointer to the Property Listing that was reviewed reservation_id?: string; // pointer to the Property Reservation that was reviewed guest_id?: string; // pointer to the Property Guest who wrote the review author_name?: string; // the reviewer name source?: string; // the channel the review was posted on, eg. Airbnb title?: string; // the review title content?: string; // the review text rating?: number; // the overall rating category_ratings?: []; // ratings per category private_feedback?: string; // private feedback for the host response?: string; // the host public reply responded_at?: string-time; // when the host replied (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) is_public?: boolean; // whether the review is publicly visible metadata?: []; // custom field values raw?: any; // raw data from the integration } ``` ## Zod ```typescript import { z } from 'zod'; export const ZodPropertyReview = z.object({ id: z.string().optional().describe("unique identifier for the review"), created_at: z.string-time().optional().describe("when the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"), updated_at: z.string-time().optional().describe("when the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"), listing_id: z.string().optional().describe("pointer to the Property Listing that was reviewed"), reservation_id: z.string().optional().describe("pointer to the Property Reservation that was reviewed"), guest_id: z.string().optional().describe("pointer to the Property Guest who wrote the review"), author_name: z.string().optional().describe("the reviewer name"), source: z.string().optional().describe("the channel the review was posted on, eg. Airbnb"), title: z.string().optional().describe("the review title"), content: z.string().optional().describe("the review text"), rating: z.number().optional().describe("the overall rating"), category_ratings: z.array().optional().describe("ratings per category"), private_feedback: z.string().optional().describe("private feedback for the host"), response: z.string().optional().describe("the host public reply"), responded_at: z.string-time().optional().describe("when the host replied (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"), is_public: z.boolean().optional().describe("whether the review is publicly visible"), metadata: z.array().optional().describe("custom field values"), }); ``` ## Python ```python import dataclasses @dataclasses.dataclass class PropertyReview: """unique identifier for the review""" id: Optional[str] """when the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)""" created_at: Optional[str] """when the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)""" updated_at: Optional[str] """pointer to the Property Listing that was reviewed""" listing_id: Optional[str] """pointer to the Property Reservation that was reviewed""" reservation_id: Optional[str] """pointer to the Property Guest who wrote the review""" guest_id: Optional[str] """the reviewer name""" author_name: Optional[str] """the channel the review was posted on, eg. Airbnb""" source: Optional[str] """the review title""" title: Optional[str] """the review text""" content: Optional[str] """the overall rating""" rating: Optional[int] """ratings per category""" category_ratings: Optional[PropertyPropertyReviewCategory_ratings] """private feedback for the host""" private_feedback: Optional[str] """the host public reply""" response: Optional[str] """when the host replied (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)""" responded_at: Optional[str] """whether the review is publicly visible""" is_public: Optional[bool] """custom field values""" metadata: Optional[PropertyPropertyReviewMetadata] ```