Sign in
latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB

3652d8b1a8b3

Reviews

Search for 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.

get/reviews

Query parameters

business__inBusinessId[]

Filter by business ids. Use a comma-separated list to provide multiple ids.

[
  "5409c35a97bbc544d8e26737"
]
business__notinBusinessId[]

Excludes from the request all businesses provided

[
  "5409c35a97bbc544d8e26737"
]
content__isnull'true' | 'false'

Filter by review's content

If set to true, the endpoint will return all the reviews without content.

Note: This is the content of the review and not the content of the reply.

partner__inReviewPublisherLabel[]

Filter by publisher

gmb_rating__innumber[]

Filter only by Google ratings

tripadvisor_rating__innumber[]

Filter only by Tripadvisor ratings

recommended__inboolean[]

Filter only by Facebook recommendation

update_date__gtestring datetime
Example:2017-08-01T00:00:00

Filter by update_date

Return all the reviews whose update_date >= given_date.

For example : update_date__gte=2019-01-01T00:00:00 will return all reviews from the first January of 2019 until today.

Note : The update dates are stored in UTC.

update_date__ltestring datetime
Example:2017-08-02T00:00:00

Filter by update_date

Return all the reviews whose update_date <= given_date.

For example : update_date__lte=2020-01-01T00:00:00 will return all reviews from the date of the first review until the first january of 2020.

Note : The update dates are stored in UTC.

state__inReviewState[]

Filter by state. Comma-separated list of review states.

state__notinReviewState[]

Exclude reviews in the given states. Comma-separated list of review states.

tag_label__inTagLabel[]

Filter by Tag label

Will partially match given labels (ie foo will match reviews with tag food)

[
  "food"
]
without_tagboolean
Example:true

Filter only reviews without tags

keywordsstring[]

Filter by keywords

Return all the reviews with not-nullable content, that contain the provided list of keywords.

Note: This is the content of the review and not the content of the reply.

The filter accepts both simple and composed words. To indicate it's a composed keyword, add the + as separator. For example:

  • keywords=bonjour returns all reviews containing the keyword bonjour
  • keywords=good+service returns all reviews containing the combined keyword good service, without splitting the keyword. No reviews containing just good or just service will be returned.
  • keywords=bonjour,good+service: returns all reviews that contain either just bonjour, either just good service or both keywords at the same time.
with_media_linksboolean
Example:true

When set to true, enriches review responses with associated customer media URLs from Google My Business. The media links will appear in the field media_links as an array of strings.

  • If with_media_links is false (default): media_links will be an empty array []
  • If with_media_links is true:
    • Reviews with associated photos: media_links will contain Google photo URLs
    • Reviews without photos: media_links will be an empty array []
pageinteger

Page number. Starts at 1. Any value lower than 1 will be considered as 1. For the number of items per page, see the per_page query parameter.

per_pageinteger

Number of items to return per page. Currently limited to 100.

order_by'update_date' | '-update_date'
Example:update_date

A - sign in front of the value indicates a descending order.

Response

OK

pageinteger

Current page number

max_pageinteger

Last page number

countinteger

Number of resources complying with filters

Example response

{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "reviews": [
    {
      "org_id": 42,
      "id": 34,
      "business_id": "5409c35a97bbc544d8e26737",
      "partner_id": "accounts/114063712393225091258/locations/74805271119400652054",
      "author_name": "Castorche",
      "date": "2017-07-01T16:10:23.156000+02:00",
      "update_date": "2017-08-01T19:15:54.256000+02:00",
      "rating": 3,
      "content": "Magasin un peu vieillot , mais personnel très sympathique, nombreuses références en rayons , un très bon choix côté vin...",
      "comments": {
        "id": 82938,
        "partner_id": "accounts/114063712393225091258/locations/74805271119400652054",
        "created": "2019-08-01T19:15:54.256000+02:00",
        "author_name": "Castorche",
        "content": "Merci ❤️",
        "date": "2017-08-01T19:15:54.256000+02:00",
        "update_date": "2017-08-01T19:15:54.256000+02:00",
        "can_edit": true,
        "review_id": 34,
        "user_id": "123456789abcdef2f60c42ff"
      },
      "tags": [
        {
          "id": 25,
          "label": "food",
          "color": "#808080"
        }
      ],
      "media_links": [
        "https://lh3.googleusercontent.com/gpms...",
        "https://lh3.googleusercontent.com/gpms-cs-s/AB8u6HYwO..."
      ]
    }
  ]
}