Get a single review with response

Get a single review together with its current response, review-site/store context, flags, connection state, and response_capabilities for the response composer (forces type=editResponse).

Auth: Both — authentication (flat /response/* route, account-scoped at the controller level). The review_id resolves to its store's company_id and validated by an ownership check, then re-checked in-controller. Any user whose company hierarchy contains the review's store passes — a partner-tier user reaches every review under its tree. An account user reaches only its own stores' reviews.

Rate limit: No rate limit.

Request

  • Query: review_id (integer, required) — must be a known review and belong to the caller's company hierarchy.

Response{ data. } envelope (the ResponseFeed resource).

  • id (int) — review id.
  • source_platform (string) — originating platform; falls back to the normalised review-site slug when null.
  • review (object) — id, reviewer, rating, message, review_date (null if zero-date).
  • reviewsite (object) — id, name (Maps.GoogleGoogle), link, review_site_logo, review_site_color, auth_type, scraping_enabled (bool), posting_enabled (bool).
  • store (object) — id, name (appends - storeid when present), slug, address (composed from company address/city/state).
  • store_reviewsite (object) — id, url, landing_page_url, connection_status, is_connected (bool; derived per-site: Google rs=44 via external_token, Facebook rs=3 via external_token+external_id, Caring rs=20 via external_id, else connection_status==connected).
  • flag (array|string) — status-badge objects (flag, title, statusColor, icon, optional links) derived from the response status + any review flag. Empty string in standalone mode.
  • plan (string) — active plan name or ''.
  • review_flag (object|null) — raw flag relation.
  • is_flaggable (bool), flag_status (string, 'none' when unflagged), flag_details (object|null: reason, reason_identifier, flag_reason_detail, flag_date).
  • Hipages-only block (present only in hipages context): flagging (window_days, expires_at, reason), is_legacy, is_qualified, is_off_platform, classification_label, job_id, sub_dimensions, is_profanity, badges, has_history, moderation (timestamps).
  • response_capabilities (object) — output (e.g. manual bool, reason); universal.
  • response (object|null) — id, status, public_contents, private_contents, response_date, deleted; null when no response (or for unverified automated responses).
  • Top-level with extras: checkUnamePass (int 0/1, edit mode), standalone_type, standalone_popup_message.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json