Getting Started
The review management API — get review data, post replies, request new reviews, and generate insights from Google, Facebook and 80+ other sites.
The review management API
The API that hundreds of marketplaces and platforms rely on to get review data, post replies, request new reviews, and generate insights — from Google, Facebook, and 80+ other review sites, through a single integration.
One API. 80+ review sites. It's plain JSON REST — successful responses come back inside a
dataobject, errors always share the same shape, and every write is authenticated with a bearer token. Learn one endpoint and the rest feel familiar.
What you can build
Pull reviews with ratings, metadata and sentiment from 80+ sites, then layer on AI insights for trending topics, competitive benchmarks and customer sentiment.
Craft and post replies straight from your own platform — without making users log in to Google, Yelp or Facebook.
Send branded review requests by SMS, email or in-store campaign, and track delivery and response rates.
Flag fake, inappropriate or policy-violating reviews; the API handles submission, tracking and per-platform rules.
Works with 80+ review sites
Google, Facebook, Yelp, BBB, Trustpilot, TripAdvisor, OpenTable, Angi, Houzz, Zillow, Airbnb, Expedia, Healthgrades, DealerRater, CarGurus — and 80+ more. Every location connects its own review sites; the API normalizes them so you work with one shape.
See it in action
Three calls — log in, read a location's reviews, then post a reply.
1. Log in and capture your token
curl -s -X POST "https://production-api.shoutaboutus.com/api/v1/login" \
-H 'Content-Type: application/json' \
-d '{"email":"[email protected]","password":"•••"}'
# → { "data": { "token": "<your-token>" } }2. Read a store's reviews
curl -s "https://production-api.shoutaboutus.com/api/v1/response/get-review?store_id=619" \
-H "Authorization: Bearer <your-token>"3. Post a reply
curl -s -X POST "https://production-api.shoutaboutus.com/api/v1/response/save" \
-H "Authorization: Bearer <your-token>" \
-H 'Content-Type: application/json' \
-d '{"review_id":123,"public_contents":"Thanks so much for the kind words!"}'Same token, same data envelope, everywhere.
How it's organized
RM is multi-tenant, arranged as a simple hierarchy. Once this clicks, the rest of the API is predictable:
| Level | What it is | Who calls it |
|---|---|---|
| Partner (agency) | The top-level tenant. Manages many accounts, locations, users, plans, webhooks and billing. | Partner token |
| Account (business) | A business operated under a partner. Owns its plan and settings. | Account token |
| Location (store) | A single store, with its own review sites, reviews, campaigns and widgets. | Account token |
Your token decides your reach. A partner token can act on everything beneath it; an account token is limited to its own account and locations. Most endpoints take a store_id (or company_id) and only let you touch data inside your scope.
After login,
company.bundle_idtells you your role:1= partner,2= location,3= account.
Get started in 5 minutes
An email + password (or an OAuth client) for your environment.
POST /login returns your bearer token as data.token.
GET /verify-token echoes who you are.
POST /store/list shows the stores you manage.
Read reviews, post a reply, or launch a campaign.
Full auth options — including the OAuth 2.0 password grant and SSO — are in the Authentication guide.
Explore the API
The API has four areas — the same folders you'll see in the sidebar. Open any endpoint for its description, parameters, a ready-to-run curl example and real response payloads.
Sign in and manage access — login, OTP, SSO, OAuth clients, sign-up, and public lookups.
Agency-level control — accounts, plans, users & roles, store provisioning, webhooks, and notifications.
Day-to-day work — locations, review-site connections, reviews & AI responses, campaigns, QR codes, widgets & branding.
Analytics and exports for both partner and account scope — dashboards, performance, ranking, insight and competitive reports.
Where to go next
The path most integrations follow, in order:
- Find your IDs — learn which endpoint returns each
store_id,review_site_idandcampaign_id. You'll need these for almost every call. - Connect review sites — link each location's Google, Facebook and other profiles so reviews start flowing in.
- Read & respond to reviews — pull a store's reviews and post replies, with AI-drafted responses if you want a head start.
- Request new reviews — launch email, SMS and QR campaigns that invite customers to leave a review.
- Measure performance — pull dashboards plus performance, ranking and insight reports.
Prefer to explore hands-on? Open the API Reference in the sidebar for an interactive "Try It" console, or import the Postman collection:
Questions? Reach the team, or explore the full API in the sidebar.
Updated 16 days ago