For AI agents: visit https://docs.shoutaboutus.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Guides API Reference

Guides

Guides API Reference

Getting Started
Environments
Responses & errors
Rate limits
Finding IDs

Build third-party review management
Build a first-party review platform
Build unified first- and third-party reviews
Add review functionality to an existing product

Authentication
Create and manage accounts
Add and manage locations
Plans and entitlements
Move locations between plan tiers

Review site catalogue
Connect review sites
Google and Facebook connections
Get reviews
- Get reviews for a location
- Get one review
Webhooks
Error notifications

Respond to reviews

AI insight report
Competitive report

Campaigns
Send a review request
Recipients
- Upload recipients
- List recipients
Email templates
SMS templates
Landing page templates
QR codes
QR code templates
Automated campaigns
Request usage and overage
- Email request usage
- Text request usage

Flag a review for removal

Review widget
- Load a widget's reviews and settings
- List widget styles
FAQ, testimonials, images and widgets
Branding and white label
White-label emails
Hosted landing page
- Configure the hosted page
- Remove a hosted page image

Partner
Account

Users and roles (partner)
Users and profile (account)
Act as an account owner
- Get a token for an account
- Get a token for a specific user
Billing address and checkout
Single sign-on
Public self-service signup
Reference data (countries, states, cities, industries)
Google connection activity report
- Google connection activity
Referral programme
- Get your referrals

Powered by

Build with Shout About Us

Build a first-party review platform

Coming soon.

Updated 4 days ago

Build third-party review management

Build unified first- and third-party reviews

Did this page help you?