Synup
Create a key
v1Resources/Review Invites/getRead invitation responses

Read invitation responses

Requires ReviewGen, an active agency user with Reviews access, and access to each owning client. Results intersect user and credential client restrictions. Optional locationId accepts native, public or legacy IDs. view:list returns rows and total, with zero-based pages of 20; view:stats returns response totals, average rating and CX score. Custom periods require valid from/to dates in ascending order and include both UTC days; dates are refused for other periods.

get/api/v1/review-invites/responses
review-invite:read
Query parameters
locationIdstringoptional
pageintegeroptional
searchstringoptional
sortstring (newest | oldest | lowest | highest)optional
ratingstring (all | 1 | 2 | 3 | 4 | 5)optional
statusstring (all | email_sms | funnel)optional
periodstring (all | 7d | 30d | 90d | 1y | custom)optional
fromstringoptional
tostringoptional
viewstring (list | stats)optional
Response
dataobjectoptional
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.
409The record changed, delivery requires approval, or the operation conflicts with existing state.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The invitation operation could not be completed. An uncertain CRM queue result retains runId; check it before retrying.
get/api/v1/review-invites/responses
Your API key
locationId
page
search
sort
rating
status
period
from
to
view
{}

Guides that use this resource