---
title: "Search for reviews"
method: GET
path: "/reviews"
tags: ["Reviews"]
---

# Search for reviews

`GET /reviews`

This endpoint lets you search for the reviews of your businesses.

To access the reviews of a business you need to have `READ` access on it.
The response is paginated (30 results per page).

By default, no state filter is applied: the response includes **all** reviews,
including deleted ones. Use `state__in` / `state__notin` to narrow the result.

## Query parameters

- `business__in` BusinessId[]
- `business__notin` BusinessId[]
- `content__isnull` 'true' | 'false'
- `partner__in` ReviewPublisherLabel[]
- `gmb_rating__in` number[]
- `tripadvisor_rating__in` number[]
- `recommended__in` boolean[]
- `update_date__gte` string, datetime
- `update_date__lte` string, datetime
- `state__in` ReviewState[]
- `state__notin` ReviewState[]
- `tag_label__in` TagLabel[]
- `without_tag` boolean
- `keywords` string[]
- `with_media_links` boolean
- `page` integer
- `per_page` integer
- `order_by` 'update_date' | '-update_date'

## Response `200`

OK

- object
  - `page` integer — Current page number
  - `max_page` integer — Last page number
  - `count` integer — Number of resources complying with filters
  - `reviews` Review[] — Filtered reviews
    - `key` string
    - `org_id` integer — Unique identifier of an organization in Partoo.
    - `id` integer — Review id
    - `business_id` string — Business id
    - `partner` 'google_my_business' | 'facebook' | 'tripadvisor' — Publisher label
    - `partner_id` string — Review id on publisher
    - `author_name` string — The author name of the review. **Note:** Replies don't have an author.
    - `date` string, datetime — Review creation date
    - `update_date` string, datetime — Review update date
    - `delete_date` string, datetime — Review deletion date (only specified if the review has been deleted)
    - `rating` integer — Review rating (can be null)
    - `recommended` boolean — Review recommended (can be null)
    - `title` string — Review title
    - `content` string — Review body content
    - `state` 'treated' | 'not_treated' | 'deleted' — Reply state
    - `link` string, uri — Link to review on publisher platform
    - `comments` Comment — Reply to a review
      - `id` integer — Comment id
      - `partner_id` string — Review id on publisher
      - `created` string, datetime — Creation date on Partoo
      - `author_name` string — The author name of the review. **Note:** Replies don't have an author.
      - `content` string — Reply content
      - `date` string, datetime — Comment date
      - `update_date` string, datetime — Comment update date. Only specified if the comment was updated
      - `can_edit` boolean — If the current user can or cannot edit a reply **Note:** This applies on Facebook replies only. A reply left by an external user on Facebook cannot be edited.
      - `review_id` integer — Review id
      - `parent_id` integer — id of the parent comment. Is only specified if the comment is a reply to another comment **Note:** This applies on Facebook replies only.
      - `user_id` string — User id of the comment author
      - `is_reply_suggestion` boolean — If AI reply suggestion was used to generate this comment
      - `replies` Comment[] — List of replies to this comment
    - `tags` Tag[] — Tags associated to the review
      - `id` integer — Tag id
      - `label` string — The label of the tag Must be <= 30 characters and cannot contain a comma (commas will be ignored)
      - `color` '#808080' | '#9B7CDB' | '#F47FBE' | '#4D4D4D' | '#9E6957' | '#2F8DE4' | '#37CED0' | '#53C944' | '#B1DA34' | '#F78234' | '#F4BD38' | '#992842' — The color of the tag, in hexadecimal representation
    - `media_links` string[] — Array of Google photo URLs associated with the review. Populated when `with_media_links=true` query parameter is used. Empty array if no associated media found or if `with_media_links=false`.

## Other responses

- `400` — Your request is incorrect
- `401` — You are not authenticated
- `403` — You are not allowed to perform this action

---

[API](https://skmtc.net/partoo/apis/partoo-rest-api.md) · [All operations](https://skmtc.net/partoo/apis/partoo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partoo/partoo-rest-api/revisions/3652d8b1a8b3/schema)
