Synupv1
Create a key
v1Resources/Reviews/getList reviews

List reviews

Returns reviews for one location. Both locationId and clientId are required.

get/api/v1/reviews
reviews:read
Query parameters
locationIdstringrequired
The location to look up.
clientIdstringrequired
The location's client.
sitesstringoptional
Comma-separated review platforms to include (e.g. google,facebook).
ratingsstringoptional
Comma-separated star ratings to include (e.g. 1,2).
sentimentstringoptional
Comma-separated sentiments to include (positive, neutral, negative).
statusstring (responded | unreplied)optional
Filter by reply status: responded or unreplied.
keywordstringoptional
Free-text search across the review body and author.
fromstringoptional
Window start (ISO date).
tostringoptional
Window end (ISO date).
sortstring (newest | oldest | lowest | highest)optional
Sort order: newest, oldest, lowest, or highest.
deletedstring (1)optional
Pass 1 to show removed/not-present reviews instead of live ones.
cursorstringoptional
Pagination cursor from a previous response's nextCursor.
limitintegeroptional
Reviews to return per page, 1-100. Defaults to 30.
Response
dataobjectoptional
foundbooleanoptional
Whether the location was found and accessible to this key.
reviewsarray of objectoptional
The reviews themselves.
idstringoptional
Unique identifier for the review.
authorstringoptional
Name of the reviewer, or null if not provided by the source.
ratingnumberoptional
Star rating, or null.
bodystringoptional
The review text.
reviewDatestringoptional
When the review was posted, as an ISO 8601 timestamp, or null.
platformstringoptional
Source platform, e.g. google, facebook.
platformLabelstringoptional
Display name of the source platform, or null.
sentimentstringoptional
Detected sentiment of the review, or null.
replyobjectoptional
The business's reply, if one was posted, or null.
authorstringoptional
bodystringoptional
datestringoptional
reviewUrlstringoptional
Link to the review on its source platform, or null.
respondablebooleanoptional
Whether a reply can still be posted to this review.
nextCursorstringoptional
Pagination cursor for the next page, or null when there are no more results.
totalnumberoptional
Total number of reviews matching the request.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/reviews
Your API key
locationId *
clientId *
sites
ratings
sentiment
status
keyword
from
to
sort
deleted
cursor
limit
{
  "data": {
    "found": true,
    "reviews": [
      {
        "id": "rev_1",
        "author": "Jane D.",
        "rating": 5,
        "body": "Great service!",
        "reviewDate": "2026-02-01T12:00:00.000Z",
        "platform": "google",
        "platformLabel": "Google",
        "sentiment": "positive",
        "reply": null,
        "reviewUrl": "https://google.com/...",
        "respondable": true
      }
    ],
    "nextCursor": null,
    "total": 1
  }
}