API Reference

Get reviews for a location

post
https://production-api.shoutaboutus.com/api/v1/partner/report/review-response/feed

Get reviews as a paginated list, newest first, each with its response (if any), the location and site it came from, its flag status, and whether you can respond to it. Also returns the average rating and a per-site summary for the reviews in scope. This is the first call most integrations make: use it to build a review feed, sync reviews into your own system, or find reviews that still need a response. Optional filters: store_id or client_location_id for one location; account_id or client_account_id for one account; leave both out for everything under your partner. Also review_site_id, rating, response status (or awaiting_response for reviews with no reply yet), a date range, and a keyword search. Page size defaults to 10. To keep your own copy in sync, send updated_since with the time of your last sync, and include_removed: true to also get the reviews removed since then. Each review carries external_review_id, created_at, updated_at and deleted_at. Each entry includes response_capabilities, telling you whether a manual or AI response is possible right now and, if not, why.

Prerequisites: a bearer token. Optional: a location or an account to narrow the feed.

Authentication: Partner token. Without a location or account, the feed covers every location under the partner; store_id, client_location_id, account_id and client_account_id must be inside your own account tree, otherwise 422. Account tokens use POST /api/v1/reports/response/feed, with the same request and response.

Rate limit: 300 requests per minute, counted per user (the token’s user).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
Defaults to 2026-01-01 00:00:00

Start of the review-date window, Y-m-d H:i:s. Use with range_end.

string
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
Defaults to 2026-12-31 23:59:59

End of the window, Y-m-d H:i:s. When both dates are sent and limit is left out, every matching review is returned in one response, without paging.

integer
10 to 100
Defaults to 10

Page size, 10–100. Default 10. Values below 10 are raised to 10; above 100 returns 422. Eligible partners default to 25, and a larger value is lowered to 25 without an error.

integer
≥ 1
Defaults to 1

The page to return, from 1.

string
enum
Defaults to review_date

Sort by review_date, rating, rate (same as rating), reviewer, created_at, updated_at, response_date or store_name. Applied only with sort_by. Default order: review_date, newest first.

string
enum
Defaults to desc

asc or desc.

Allowed:
string
enum
Defaults to report

report or download.

Allowed:
integer
Defaults to 3007

Only this location. Must exist and be inside your account tree.

string
length ≤ 255
Defaults to docs-test-loc-001

Your own id for the location, instead of store_id. Up to 255 characters.

integer
Defaults to 5994

Only this account's locations. Must be an active account inside your account tree.

string
length ≤ 255
Defaults to ACC-001

Your own id for the account, instead of account_id. Up to 255 characters.

integer
enum
Defaults to 0

0 or 1. 1: logo URLs point at the API host instead of the CDN.

Allowed:
integer
Defaults to 44

Only reviews from this review site.

rating
array of integers
Defaults to 4,5

Only these star ratings, e.g. [4, 5]. A single number is accepted too.

rating
string
enum
Defaults to awaiting_response

Only reviews whose response is complete, pending, error, flagged or removed; or awaiting_response: reviews with no response yet that the location may respond to under its plan (the same set as the dashboard's Awaiting Response count).

Allowed:
string
length ≤ 255
Defaults to clean

Matches part of the reviewer or customer name, the review text or title, the job id, or the location name. Up to 255 characters.

string
Defaults to 2026-10-01 00:00:00

Only reviews we collected at or after this time, UTC, Y-m-d H:i:s. Compares against created_at.

string
Defaults to 2026-10-01 00:00:00

Only reviews that changed at or after this time, UTC, Y-m-d H:i:s. Compares against updated_at; with include_removed, also matches reviews removed at or after it. Send the time of your last sync to get only what changed. A change is a new review, an edit to its rating, text, reviewer name or date, a moderation change (for example hidden or suppressed), a removal or a restore. A new or changed reply, or a change to a removal request (flag), doesn't count: those arrive as response_* and flag_* webhooks.

boolean
Defaults to true

Also return reviews removed on our side, with deleted_at set. Off by default. Not the same as status=removed, which filters on the review site reporting the review gone.

Responses

Updated 18 days ago

Did this page help you?
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

Updated 18 days ago

Did this page help you?