Skip to main content
GET
/
reviews
Search for reviews
curl --request GET \
  --url https://api.partoo.co/v2/reviews \
  --header 'x-APIKey: <api-key>'
{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "reviews": [
    {
      "key": "<string>",
      "org_id": 42,
      "id": 34,
      "business_id": "5409c35a97bbc544d8e26737",
      "partner": "google_my_business",
      "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",
      "delete_date": "<string>",
      "rating": 3,
      "recommended": true,
      "title": "<string>",
      "content": "Magasin un peu vieillot , mais personnel très sympathique, nombreuses références en rayons , un très bon choix côté vin...",
      "state": "treated",
      "link": "<string>",
      "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,
        "parent_id": 123,
        "user_id": "123456789abcdef2f60c42ff",
        "is_reply_suggestion": true,
        "replies": "<array>"
      },
      "tags": [
        {
          "id": 25,
          "label": "food",
          "color": "#808080"
        }
      ],
      "media_links": [
        "https://lh3.googleusercontent.com/gpms...",
        "https://lh3.googleusercontent.com/gpms-cs-s/AB8u6HYwO..."
      ]
    }
  ]
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Query Parameters

​
business__in
string[]

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

Example:

"a1c9f37b4deca92f83b61d02,9f4e2a8c0d73b154e621bc97,c73b15e9fa42d60b3a8c21ef"

​
business__notin
string[]

Excludes from the request all businesses provided

Business id

​
content__isnull
enum<string>

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.

Available options:
true,
false
Example:

false

​
partner__in
enum<string>[]

Filter by publisher

Publisher label

Available options:
google_my_business,
facebook,
tripadvisor
Example:

"google_my_business,facebook"

​
gmb_rating__in
enum<number>[]

Filter only by Google ratings

Available options:
1,
2,
3,
4,
5
Example:

"4,5"

​
tripadvisor_rating__in
enum<number>[]

Filter only by Tripadvisor ratings

Available options:
1,
2,
3,
4,
5
Example:

"1,2"

​
recommended__in
enum<boolean>[]

Filter only by Facebook recommendation

Available options:
true,
false
Example:

false

​
update_date__gte
string<datetime>

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.

Example:

"2017-08-01T00:00:00"

​
update_date__lte
string<datetime>

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.

Example:

"2017-08-02T00:00:00"

​
state__in
enum<string>[]

Filter by state

Reply state

Available options:
treated,
not_treated,
deleted
Example:

"treated,not_treated"

​
tag_label__in
string[]

Filter by Tag label

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

The label of the tag Must be <= 30 characters and cannot contain a comma (commas will be ignored)

Example:

"food,drink"

​
without_tag
boolean

Filter only reviews without tags

Example:

true

​
keywords
string[]

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.
Example:

"bonjour,good+service"

​
with_media_links
boolean
default:false

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 []
Example:

true

​
page
integer
default:1

Page number, Starts at 1. From 1 to 100 results per page (see per_page)

​
per_page
integer
default:30

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

Required range: 1 <= x <= 100
​
order_by
enum<string>

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

Available options:
update_date,
-update_date
Example:

"update_date"

Response

OK

​
page
integer

Current page number

Example:

1

​
max_page
integer

Last page number

Example:

10

​
count
integer

Number of resources complying with filters

Example:

287

​
reviews
object[]

Filtered reviews