# Reviews Reviews of stays, left by guests or imported from other platforms Endpoint: `https://api.bookingmood.com/v1/reviews`, supporting `GET`, `POST`, `DELETE`, `PATCH`. Authenticate with the header `Authorization: Bearer YOUR_API_KEY` (see [authentication](https://www.bookingmood.com/pt-BR/api-reference/authentication.md)). ## The review object | Attribute | Type | Description | | --- | --- | --- | | `id` | `uuid` | | | `booking_id` | `uuid \| null` | Identifier of the reviewed booking. References [`bookings.id`](https://www.bookingmood.com/pt-BR/api-reference/bookings.md). | | `organization_id` | `uuid` | Identifier of the organization this review is defined in. References [`organizations.id`](https://www.bookingmood.com/pt-BR/api-reference/organizations.md). | | `source_id` | `text \| null` | Identifier of the review on its source. | | `created_at` | `timestamp with time zone` | Creation timestamp. Read-only: set by the database. | | `updated_at` | `timestamp with time zone` | Last modification timestamp. Read-only: set by the database. | | `author_avatar` | `text \| null` | URL of the author's avatar image. | | `author_name` | `text` | Name of the author. | | `content` | `MultiLanguageString` | Localized text of the review. | | `fts` | `tsvector` | Read-only: set by the database. | | `rating` | `integer \| null` | Rating given by the author. | | `source` | `text` | Where the review comes from. | | `source_url` | `text \| null` | URL of the review on its source. | | `status` | `ReviewStatus` | Moderation status: `pending`, `approved` or `rejected`. Review widgets only show approved reviews. | ```json { "id": "00000000-0000-0000-0000-000000000000", "booking_id": "00000000-0000-0000-0000-000000000000", "organization_id": "00000000-0000-0000-0000-000000000000", "source_id": "", "created_at": "2026-10-30T23:37:06.265Z", "updated_at": "2026-10-30T23:37:06.265Z", "author_avatar": "", "author_name": "Summer cottage", "content": {}, "rating": 0, "source": "", "source_url": "https://example.com", "status": "pending" } ``` ### Types ```typescript type Language = | "be-BY" | "bg-BG" | "cs-CZ" | "da-DK" | "de-DE" | "en-GB" | "en-NZ" | "en-US" | "es-ES" | "eu-ES" | "fr-FR" | "gr-EL" | "he-IL" | "hr-HR" | "hu-HU" | "it-IT" | "ja-JP" | "lt-LT" | "lv-LV" | "nl-NL" | "nn-NO" | "pl-PL" | "pt-BR" | "ro-RO" | "ru-RU" | "sk-SK" | "sl-SI" | "sr-Cyrl" | "sr-Latn" | "sv-SE" | "tr-TR" | "uk-UA"; type MultiLanguageString = { default: string; } & Partial>; type ReviewStatus = "pending" | "approved" | "rejected"; ``` ### Related resources Embed related resources with the [`select` parameter](https://www.bookingmood.com/pt-BR/api-reference/selecting.md), e.g. `select=*,bookings(*)`. Resources related through more than one column need the column as a hint, like `table!column(*)`. | Embed | Type | Description | | --- | --- | --- | | `bookings(*)` | `object \| null` | The [booking](https://www.bookingmood.com/pt-BR/api-reference/bookings.md) referenced by `booking_id`. | | `organizations(*)` | `object \| null` | The [organization](https://www.bookingmood.com/pt-BR/api-reference/organizations.md) referenced by `organization_id`. | | `review_products(*)` | `array` | The [review products](https://www.bookingmood.com/pt-BR/api-reference/review_products.md) referencing this review through `review_products.review_id`. | ## List reviews `GET /v1/reviews` Filter on any attribute with `column=operator.value` (see [filtering](https://www.bookingmood.com/pt-BR/api-reference/filtering.md)). Choose columns and embed related resources with `select` (see [selecting](https://www.bookingmood.com/pt-BR/api-reference/selecting.md)), and sort and paginate with `order`, `limit` and `offset` (see [sorting and pagination](https://www.bookingmood.com/pt-BR/api-reference/sorting-pagination.md)). ```bash curl -X GET "https://api.bookingmood.com/v1/reviews?select=*&limit=10" \ -H "Authorization: Bearer YOUR_API_KEY" ``` Responses: - `200`: A list of reviews with the selected columns. `206` when the list is a partial range. - `400`: The request is malformed, for example an unknown column or an invalid filter. - `401`: The API key is missing or invalid. ## Create reviews `POST /v1/reviews` Insert one review or an array of reviews. The body is a `Partial` review object, so columns with a default can be left out. Read-only attributes can't be written. ```bash curl -X POST "https://api.bookingmood.com/v1/reviews" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "organization_id": "00000000-0000-0000-0000-000000000000", "author_name": "Summer cottage", "content": {}, "source": "", "status": "pending" }' ``` Responses: - `201`: The newly created reviews with the selected columns. - `400`: The request is malformed, for example an unknown column, an invalid filter or an invalid body. - `401`: The API key is missing or invalid. - `403`: The API key has no permission for this change, for example when writing rows of another organization. - `409`: The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist. ## Delete reviews `DELETE /v1/reviews` Filter on any attribute with `column=operator.value` (see [filtering](https://www.bookingmood.com/pt-BR/api-reference/filtering.md)). Without filters, this request deletes all reviews you have access to. Always filter on at least one column, e.g. `id=eq.{id}`. ```bash curl -X DELETE "https://api.bookingmood.com/v1/reviews?id=eq.00000000-0000-0000-0000-000000000000" \ -H "Authorization: Bearer YOUR_API_KEY" ``` Responses: - `200`: The deleted reviews with the selected columns. `204` without a body when sending the header `Prefer: return=minimal`. - `400`: The request is malformed, for example an unknown column or an invalid filter. - `401`: The API key is missing or invalid. - `403`: The API key has no permission for this change, for example when writing rows of another organization. ## Update reviews `PATCH /v1/reviews` Filter on any attribute with `column=operator.value` (see [filtering](https://www.bookingmood.com/pt-BR/api-reference/filtering.md)). Without filters, this request updates all reviews you have access to. Always filter on at least one column, e.g. `id=eq.{id}`. The body holds the attributes to change. ```bash curl -X PATCH "https://api.bookingmood.com/v1/reviews?id=eq.00000000-0000-0000-0000-000000000000" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "author_name": "Summer cottage" }' ``` Responses: - `200`: The updated reviews with the selected columns. `204` without a body when sending the header `Prefer: return=minimal`. - `400`: The request is malformed, for example an unknown column, an invalid filter or an invalid body. - `401`: The API key is missing or invalid. - `403`: The API key has no permission for this change, for example when writing rows of another organization. - `409`: The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist. Errors have a JSON body with a `code`, `message`, `details` and `hint`. See the [introduction](https://www.bookingmood.com/pt-BR/api-reference.md) for more on errors. The full API is described by the OpenAPI spec at https://api.bookingmood.com/v1/openapi.json.