Prerequisites
Before retrieving reviews, ensure you have:- Active subscription to the Review Management
- API key with Business Manager role or higher
-
Platform Integrations: Ensure your platforms are integrated properly
- Google My Business
- Facebook
- TripAdvisor
- Custom partners
- Valid Google My Business location ID (
google_location_id) - Active OAuth account with proper scopes
- GMB location must be linked to the business
How the Reviews Mechanism Works
Partoo automatically collects reviews from Google, Facebook, and TripAdvisor platforms and makes them available through a unified API.Review Collection
- Scheduled fetching: Reviews are collected daily at different times for each platform:
- Google My Business: 8:15 PM UTC
- Facebook: 7:00 PM UTC
- TripAdvisor: 8:00 PM UTC
- 24-hour delay: New reviews may take up to 24 hours to appear in the API
- Live fetch: Google My Business reviews are fetched when Google sends webhook notifications
- Platform integration: Only reviews from connected platforms are available
- Custom partners: nothing is collected, you push the reviews, and they are available immediately
Review States
Each review has one of these states:treated: Has a reply or was marked as treatednot_treated: No reply yet and not marked as treateddeleted: Was removed by the user on the original platformpending_auto_reply: Queued for automatic responsetreated_auto_reply: Has a reply via automatic response
Important: Unless they are from custom partners you handle on your side, you can only reply to reviews via the API, not modify or delete the original review content.
Reply Templates
Reply templates help you respond quickly to reviews with predefined messages. They’re designed for use within the Partoo application. You cannot access a formatted template with prefilled placeholders from the API. However, you can manage these templates through the API:- Browse through existing reply templates
- Create new reply templates
- Delete reply templates
Custom Review Partners
A custom review partner is a source of reviews Partoo does not synchronize itself: your own app, a marketplace, a delivery platform. You push those reviews through the API, and they then behave like any other reviews: searchable, repliable, and carried by thereview_created and review_updated webhooks. Replies written in Partoo travel the other way: they are sent back to you so you can publish them on your platform.
What you need
1
Get your custom partner created
Custom partners are set up by Partoo. Contact your Account Manager with the platform you want to bring in, and you get back a partner slug, for example
my_partner, that identifies it in every call.2
Check that it is enabled on your organization
is_custom: true. A partner missing from that list is not enabled for your organization yet, and pushing reviews to it is refused.3
Use an API key with the right rights
Pushing and deleting reviews requires an API key whose user is an
ORG_ADMIN and carries the review_edit permission. You can only push for businesses of your own organization.Push your reviews
partner_slug, external_id) identifies the review: the first call creates it, and every later call with the same pair updates it in place.
Correct and delete
- Correct a review: push it again with the same
partner_slugandexternal_id. Rating, content, author, dates, link and reply are all updated. - Delete a review:
DELETE /reviews/{review_id}, using the Partooidreturned by the push.
Read them back
Get the replies back
Your teams answer those reviews inside Partoo, from the app or throughPOST /comments. Partoo cannot publish that answer on your platform, it is yours, so it hands it back to you: every reply written, edited or deleted on one of your custom-partner reviews calls the endpoint you gave us, and you publish it on your side.
These three events can be setup from Settings > Integrations > Webhooks or by API as explained on the Webhooks documentation.
Tips to Retrieve Reviews Effectively
1
Use the Search Endpoint
Start with the main search endpoint to retrieve reviews:
2
Apply Smart Filtering
Use the available filters to narrow down your results:
- Business Filtering
- Status Filtering
- Platform Filtering
- Date Range Filtering
3
Implement Pagination
Handle large datasets efficiently with cursor-based pagination:
The default page size is 30 reviews per page, with a maximum of 100 reviews per page. Use cursor-based pagination for better performance with large datasets.
4
Use Keywords Search
Search for specific content within reviews:
5
Sort Results Effectively
Order your results for better management:
Available ordering fields:
id, author_name, date, update_date, rating, state, title, partner. Prefix with - for descending order.