Synupv1
Create a key
v1Resources/Reviews

Reviews

Read and reply to a location's customer reviews.

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

List reviews

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
  }
}
v1Resources/Reviews/getGet reviews summary

Returns a rolled-up review summary across your agency (or one client) — rating distribution, volume, and trend over the selected date range.

Get reviews summary

get/api/v1/reviews/summary
reviews:read
Query parameters
clientIdstringoptional
Limit to one client's reviews. Omitted, this summarizes every review your key can see.
tagsstringoptional
Limit to locations carrying any of these comma-separated internal tags.
fromstringoptional
Start of the date range (inclusive), as YYYY-MM-DD. Defaults to a recent rolling window.
tostringoptional
End of the date range (inclusive), as YYYY-MM-DD. Defaults to today.
Response
dataobjectoptional
The rolled-up summary payload — rating distribution, review volume, and trend data for the selected range.
Errors
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/summary
Your API key
clientId
tags
from
to
{}
v1Resources/Reviews/getList review sources

Every review source for a location — connected platforms (Google, Facebook, ...) plus custom URLs (Yelp, TripAdvisor, ...), with status and hide state.

List review sources

get/api/v1/reviews/sources
reviews:read
Query parameters
locationIdstringrequired
The location to look up.
clientIdstringrequired
The location's client.
Response
dataobjectoptional
sourcesarray of objectoptional
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/reviews/sources
Your API key
locationId *
clientId *
{}
v1Resources/Reviews/postAdd a custom review source

Adds a custom review-page URL (Yelp, TripAdvisor, Trustpilot, or any business review page) as a source for this location. The platform is auto-detected from the URL. Does not live-validate the URL before adding — a bad URL surfaces later as a failed scrape.

Add a custom review source

post/api/v1/reviews/sources
reviews:write
Request body
locationIdstringrequired
clientIdstringrequired
urlstringrequired
The review page URL to add.
Response
dataobjectoptional
idstringoptional
The newly created custom source's id.
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.
404The resource wasn't found, or doesn't belong to your agency.
409This URL is already a source for this location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/reviews/sources
Your API key
Request body*
{}
v1Resources/Reviews/patchUpdate a review source

Hide/unhide a source (auto platform or custom), or change a custom source's fetch interval.

Update a review source

patch/api/v1/reviews/sources/{id}
reviews:write
Query parameters
idstringrequired
The source's key — an auto platform slug (e.g. "google") or a custom source id.
Request body
typestring (auto | custom)required
locationIdstringrequired
clientIdstringrequired
hidebooleanoptional
Set true to hide this source from the reviews view, false to unhide.
fetchIntervalHoursintegeroptional
New scrape interval in hours. Custom sources only.
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.
404The resource wasn't found, or doesn't belong to your agency.
422The request is missing a required parameter or is otherwise malformed.
429Too many requests. Retry after the number of seconds in the Retry-After header.
patch/api/v1/reviews/sources/{id}
Your API key
id *
Request body*
{}
v1Resources/Reviews/deleteRemove a custom review source

Permanently removes a custom review source and stops scraping it.

Remove a custom review source

delete/api/v1/reviews/sources/{id}
reviews:write
Query parameters
idstringrequired
locationIdstringrequired
clientIdstringrequired
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
delete/api/v1/reviews/sources/{id}
Your API key
id *
locationId *
clientId *
{}
v1Resources/Reviews/postRetry a stalled/failed review source

Resets a custom source's failure state and puts it back in line for an immediate scrape.

Retry a stalled/failed review source

post/api/v1/reviews/sources/{id}/retry
reviews:write
Query parameters
idstringrequired
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/reviews/sources/{id}/retry
Your API key
id *
{}
v1Resources/Reviews/getGet review analytics

KPIs (with period-over-period deltas), a monthly trend (volume, rating, sentiment mix, response rate), rating distribution, per-platform breakdown, day-of-week timing, an agency benchmark, themes, and an AI summary — for one location.

Get review analytics

get/api/v1/reviews/analytics
reviews:read
Query parameters
locationIdstringrequired
The location to look up.
clientIdstringrequired
The location's client.
kpiDaysinteger (7 | 30 | 90)optional
KPI window in days: 7, 30, or 90. Defaults to 30.
trendMonthsinteger (3 | 6 | 12)optional
Trend length in months: 3, 6, or 12. Defaults to 6.
Response
dataobjectoptional
The full Review Analytics payload.
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/reviews/analytics
Your API key
locationId *
clientId *
kpiDays
trendMonths
{}
v1Resources/Reviews/getGet a review analytics summary

Review analytics aggregated across this client's (or the whole agency's) locations: count, average rating, rating distribution, sentiment mix, response rate, per-platform breakdown, and a monthly trend. Scope to a subset with tags.

Get a review analytics summary

get/api/v1/reviews/analytics/summary
reviews:read
Query parameters
clientIdstringoptional
Limit to one client's locations.
tagsstringoptional
Comma-separated location tag names — only locations carrying at least one of these are included.
monthsintegeroptional
Trend length in months. Default 6.
Response
dataobjectoptional
locationsnumberoptional
Number of locations in scope.
countnumberoptional
Total reviews in scope.
avgRatingnumberoptional
Average rating across the scope.
distributionobjectoptional
Review count per star rating (1-5).
sentimentobjectoptional
Review count by sentiment.
positivenumberoptional
neutralnumberoptional
negativenumberoptional
responseRatenumberoptional
Percentage of reviews with a reply.
byPlatformarray of objectoptional
Count and average rating per platform.
platformstringoptional
countnumberoptional
avgRatingnumberoptional
trendarray of objectoptional
Monthly count and average rating.
monthstringoptional
countnumberoptional
avgRatingnumberoptional
Errors
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/analytics/summary
Your API key
clientId
tags
months
{}
v1Resources/Reviews/getList tracked competitors

The competitors tracked for a location.

List tracked competitors

get/api/v1/reviews/competitors
reviews:read
Query parameters
locationIdstringoptional
apiDocs.resources.reviews.competitors.get.paramsLocationId
clientIdstringoptional
apiDocs.resources.reviews.competitors.get.paramsClientId
Response
dataobjectoptional
competitorsarray of objectoptional
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/reviews/competitors
Your API key
locationId
clientId
{}
v1Resources/Reviews/postAdd a competitor

Starts tracking a competitor by name for a location.

Add a competitor

post/api/v1/reviews/competitors
reviews:write
Request body
locationIdstringoptional
apiDocs.resources.reviews.competitors.post.paramsLocationId
clientIdstringoptional
apiDocs.resources.reviews.competitors.post.paramsClientId
namestringrequired
The competitor's business name.
Response
dataobjectoptional
competitorobjectoptional
One competitor's profile row (id, name, source, pinned, etc.).
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/reviews/competitors
Your API key
Request body*
{}
v1Resources/Reviews/getGet competitive review analysis

Benchmark a location's reviews against its tracked competitors: scorecard, strengths/gaps, and review velocity + share-of-voice.

Get competitive review analysis

get/api/v1/reviews/competitors/analysis
reviews:read
Query parameters
locationIdstringrequired
clientIdstringrequired
Response
dataobjectoptional
The full competitive analysis payload (scorecard, strengths/gaps, velocity).
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/reviews/competitors/analysis
Your API key
locationId *
clientId *
{}
v1Resources/Reviews/deleteRemove a tracked competitor

Permanently stops tracking a competitor by id.

Remove a tracked competitor

delete/api/v1/reviews/competitors/{id}
reviews:write
Query parameters
idstringrequired
Errors
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.
delete/api/v1/reviews/competitors/{id}
Your API key
id *
{}
v1Resources/Reviews/postRefresh a competitor's reviews

Re-scrapes one tracked competitor's Google reviews.

Refresh a competitor's reviews

post/api/v1/reviews/competitors/{id}/refresh
reviews:write
Query parameters
idstringrequired
Response
dataobjectoptional
okbooleanoptional
notestringoptional
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/reviews/competitors/{id}/refresh
Your API key
id *
{}
v1Resources/Reviews/postapiDocs.resources.reviews.competitorsRefresh.summary

apiDocs.resources.reviews.competitorsRefresh.description

apiDocs.resources.reviews.competitorsRefresh.summary

post/api/v1/reviews/competitors/refresh
reviews:write
Request body
clientIdstringrequired
apiDocs.resources.reviews.competitorsRefresh.paramsClientId
Response
dataobjectoptional
okbooleanoptional
queuedbooleanoptional
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.
post/api/v1/reviews/competitors/refresh
Your API key
Request body*
{}
v1Resources/Reviews/getapiDocs.resources.reviews.notes.get.summary

apiDocs.resources.reviews.notes.get.description

apiDocs.resources.reviews.notes.get.summary

get/api/v1/reviews/notes
reviews:read
Query parameters
reviewIdstringrequired
apiDocs.resources.reviews.notes.get.paramsReviewId
Response
dataobjectoptional
notesarray of objectoptional
idstringoptional
apiDocs.resources.reviews.notes.fields.id
bodystringoptional
apiDocs.resources.reviews.notes.fields.body
authorUserIdstringoptional
apiDocs.resources.reviews.notes.fields.authorUserId
authorNamestringoptional
apiDocs.resources.reviews.notes.fields.authorName
createdAtstringoptional
apiDocs.resources.reviews.notes.fields.createdAt
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/reviews/notes
Your API key
reviewId *
{}
v1Resources/Reviews/postapiDocs.resources.reviews.notes.post.summary

apiDocs.resources.reviews.notes.post.description

apiDocs.resources.reviews.notes.post.summary

post/api/v1/reviews/notes
reviews:write
Request body
reviewIdstringrequired
apiDocs.resources.reviews.notes.post.paramsReviewId
bodystringrequired
apiDocs.resources.reviews.notes.post.paramsBody
Response
dataobjectoptional
idstringoptional
apiDocs.resources.reviews.notes.fields.id
bodystringoptional
apiDocs.resources.reviews.notes.fields.body
authorUserIdstringoptional
apiDocs.resources.reviews.notes.fields.authorUserId
authorNamestringoptional
apiDocs.resources.reviews.notes.fields.authorName
createdAtstringoptional
apiDocs.resources.reviews.notes.fields.createdAt
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/reviews/notes
Your API key
Request body*
{}
v1Resources/Reviews/deleteapiDocs.resources.reviews.notes.delete.summary

apiDocs.resources.reviews.notes.delete.description

apiDocs.resources.reviews.notes.delete.summary

delete/api/v1/reviews/notes
reviews:write
Query parameters
reviewIdstringrequired
apiDocs.resources.reviews.notes.delete.paramsReviewId
noteIdstringrequired
apiDocs.resources.reviews.notes.delete.paramsNoteId
Response
dataobjectoptional
deletedbooleanoptional
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.
delete/api/v1/reviews/notes
Your API key
reviewId *
noteId *
{}
v1Resources/Reviews/postapiDocs.resources.reviews.topicKeywords.post.summary

apiDocs.resources.reviews.topicKeywords.post.description

apiDocs.resources.reviews.topicKeywords.post.summary

post/api/v1/reviews/topic-trends/keywords
reviews:write
Request body
locationIdstringoptional
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringoptional
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringrequired
apiDocs.resources.reviews.topicKeywords.paramsKeyword
Response
dataobjectoptional
customarray of stringoptional
apiDocs.resources.reviews.topicKeywords.fieldsCustom
queuedbooleanoptional
notestringoptional
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/reviews/topic-trends/keywords
Your API key
Request body*
{}
v1Resources/Reviews/deleteapiDocs.resources.reviews.topicKeywords.delete.summary

apiDocs.resources.reviews.topicKeywords.delete.description

apiDocs.resources.reviews.topicKeywords.delete.summary

delete/api/v1/reviews/topic-trends/keywords
reviews:write
Query parameters
locationIdstringoptional
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringoptional
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringrequired
apiDocs.resources.reviews.topicKeywords.paramsKeyword
Response
dataobjectoptional
customarray of stringoptional
apiDocs.resources.reviews.topicKeywords.fieldsCustom
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.
delete/api/v1/reviews/topic-trends/keywords
Your API key
locationId
clientId
keyword *
{}
v1Resources/Reviews/patchapiDocs.resources.reviews.topicKeywords.patch.summary

apiDocs.resources.reviews.topicKeywords.patch.description

apiDocs.resources.reviews.topicKeywords.patch.summary

patch/api/v1/reviews/topic-trends/keywords
reviews:write
Request body
locationIdstringoptional
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringoptional
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringrequired
apiDocs.resources.reviews.topicKeywords.paramsKeyword
hidebooleanrequired
apiDocs.resources.reviews.topicKeywords.paramsHide
Response
dataobjectoptional
customarray of stringoptional
apiDocs.resources.reviews.topicKeywords.fieldsCustom
hiddenarray of stringoptional
apiDocs.resources.reviews.topicKeywords.fieldsHidden
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.
patch/api/v1/reviews/topic-trends/keywords
Your API key
Request body*
{}
v1Resources/Reviews/getGet topic trends

A bucketed time series per review topic, a leaderboard, rising/declining movers, and emerging/faded topics — for one location.

Get topic trends

get/api/v1/reviews/topic-trends
reviews:read
Query parameters
locationIdstringrequired
clientIdstringrequired
windowDaysinteger (30 | 90 | 180)optional
Trend window in days: 30, 90, or 180. Defaults to 90.
Response
dataobjectoptional
The full Topic Trends payload.
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/reviews/topic-trends
Your API key
locationId *
clientId *
windowDays
{}
v1Resources/Reviews/getGet a topic's longer month-series

A longer month-by-month series for topics, beyond the standard trend window.

Get a topic's longer month-series

get/api/v1/reviews/topic-trends/series
reviews:read
Query parameters
locationIdstringrequired
clientIdstringrequired
monthsintegeroptional
Series length in months. Defaults to 12.
Response
dataobjectoptional
The full topic month-series payload.
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/reviews/topic-trends/series
Your API key
locationId *
clientId *
months
{}
v1Resources/Reviews/getGet reviews mentioning a topic

Drill into the reviews that mention one topic, optionally narrowed to one month.

Get reviews mentioning a topic

get/api/v1/reviews/topic-trends/reviews
reviews:read
Query parameters
locationIdstringrequired
clientIdstringrequired
topicstringrequired
The topic to look up (from GET /api/v1/reviews/topic-trends).
monthstringoptional
Narrow to one heatmap cell (YYYY-MM). Omit for the full history.
limitintegeroptional
Max reviews to return.
Response
dataobjectoptional
reviewsarray of objectoptional
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/reviews/topic-trends/reviews
Your API key
locationId *
clientId *
topic *
month
limit
{}
v1Resources/Reviews/getList review widgets

Every review widget configured for a location.

List review widgets

get/api/v1/reviews/widgets
reviews:read
Query parameters
locationIdstringrequired
clientIdstringrequired
Response
dataobjectoptional
widgetsarray of objectoptional
idstringoptional
agencyIdstringoptional
locationIdstringoptional
clientLocationIdstringoptional
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstringoptional
manualReviewIdsarray of stringoptional
countintegeroptional
includeInternalbooleanoptional
emojiPositiveRatingintegeroptional
layoutstringoptional
marqueeSpeedintegeroptional
themeobjectoptional
themeOverridesobjectoptional
showFlagsobjectoptional
statusstring (draft | published)optional
createdAtstringoptional
updatedAtstringoptional
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/reviews/widgets
Your API key
locationId *
clientId *
{}
v1Resources/Reviews/postCreate a review widget

Creates a new embeddable review widget (rating badge + review carousel/list) for a location.

Create a review widget

post/api/v1/reviews/widgets
reviews:write
Request body
locationIdstringrequired
clientIdstringrequired
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstring (30d | 90d | 1y | all)optional
countintegeroptional
includeInternalbooleanoptional
layoutstringoptional
statusstring (draft | published)optional
Response
dataobjectoptional
widgetobjectoptional
idstringoptional
agencyIdstringoptional
locationIdstringoptional
clientLocationIdstringoptional
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstringoptional
manualReviewIdsarray of stringoptional
countintegeroptional
includeInternalbooleanoptional
emojiPositiveRatingintegeroptional
layoutstringoptional
marqueeSpeedintegeroptional
themeobjectoptional
themeOverridesobjectoptional
showFlagsobjectoptional
statusstring (draft | published)optional
createdAtstringoptional
updatedAtstringoptional
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/reviews/widgets
Your API key
Request body*
{}
v1Resources/Reviews/getGet a review widget

Returns the full config for one review widget.

Get a review widget

get/api/v1/reviews/widgets/{id}
reviews:read
Query parameters
idstringrequired
Response
dataobjectoptional
widgetobjectoptional
idstringoptional
agencyIdstringoptional
locationIdstringoptional
clientLocationIdstringoptional
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstringoptional
manualReviewIdsarray of stringoptional
countintegeroptional
includeInternalbooleanoptional
emojiPositiveRatingintegeroptional
layoutstringoptional
marqueeSpeedintegeroptional
themeobjectoptional
themeOverridesobjectoptional
showFlagsobjectoptional
statusstring (draft | published)optional
createdAtstringoptional
updatedAtstringoptional
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/reviews/widgets/{id}
Your API key
id *
{}
v1Resources/Reviews/patchUpdate a review widget

Updates a widget's config or design (or publishes it, via status).

Update a review widget

patch/api/v1/reviews/widgets/{id}
reviews:write
Query parameters
idstringrequired
Request body
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstringoptional
manualReviewIdsarray of stringoptional
countintegeroptional
includeInternalbooleanoptional
emojiPositiveRatingintegeroptional
layoutstringoptional
marqueeSpeedintegeroptional
themeobjectoptional
themeOverridesobjectoptional
showFlagsobjectoptional
statusstring (draft | published)optional
Response
dataobjectoptional
widgetobjectoptional
idstringoptional
agencyIdstringoptional
locationIdstringoptional
clientLocationIdstringoptional
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstringoptional
manualReviewIdsarray of stringoptional
countintegeroptional
includeInternalbooleanoptional
emojiPositiveRatingintegeroptional
layoutstringoptional
marqueeSpeedintegeroptional
themeobjectoptional
themeOverridesobjectoptional
showFlagsobjectoptional
statusstring (draft | published)optional
createdAtstringoptional
updatedAtstringoptional
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
patch/api/v1/reviews/widgets/{id}
Your API key
id *
Request body
{}
v1Resources/Reviews/deleteDelete a review widget

Permanently deletes a review widget. The public embed stops serving once deleted.

Delete a review widget

delete/api/v1/reviews/widgets/{id}
reviews:write
Query parameters
idstringrequired
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
delete/api/v1/reviews/widgets/{id}
Your API key
id *
{}
v1Resources/Reviews/postReply to a review

Posts an owner reply to a review and pushes it to the source platform. Fails with a business-rule error (422) if the review isn't respondable — e.g. it was removed from its source.

Reply to a review

post/api/v1/reviews/reply
reviews:write
Request body
reviewIdstringrequired
The review to reply to. Required.
textstringrequired
The reply text to post. Required.
Response
dataobjectoptional
okbooleanoptional
Whether the reply was accepted.
pushedbooleanoptional
Whether the reply was actually pushed to the source platform (vs. queued).
statusstring (posted | pending | failed | draft)optional
One of: posted, pending, failed, draft.
externalReplyIdstringoptional
The reply's id on the source platform, or null.
retryablebooleanoptional
When the push failed, whether retrying might succeed — null when not applicable.
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.
404The resource wasn't found, or doesn't belong to your agency.
422The request is missing a required parameter or is otherwise malformed.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/reviews/reply
Your API key
Request body*
{}