v1Resources/Review Invites/getRead private review responses

Read private review responses

Requires ReviewGen, Reviews access and owning-client access. Reads first-party private feedback within user and credential restrictions. Optional locationId, zero-based pages of 20, rating, sentiment, sort and search filters. hasText and widgetEligible accept true/false; widget eligibility selects ratings of at least four. Returns rows and total.

get/api/v1/review-invites/internal-reviews
review-invite:read
Query parameters
locationIdstringoptional
pageintegeroptional
searchstringoptional
sortstring (newest | oldest | lowest | highest)optional
ratingstring (all | 1 | 2 | 3 | 4 | 5)optional
sentimentstring (all | positive | neutral | negative)optional
hasTextbooleanoptional
widgetEligiblebooleanoptional
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/internal-reviews
Your API key
locationId
page
search
sort
rating
sentiment
hasText
widgetEligible
{}

Guides that use this resource