For AI agents: the docs index is at https://docs.shoutaboutus.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Guides
API Reference
v2.0
Guides
Log In
Jump to Content
v2.0
Guides
API Reference
Ranking report
Log In
Getting Started
Getting Started
Environments
Responses & errors
Rate limits
Finding IDs
Build with Shout About Us
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
Setup
Authentication
Personal access token
App credentials (OAuth 2.0)
Step 1: Send the user to sign in
Step 2: Receive the code
Step 3: Exchange the code for a token
Revoke a token
Check your token
Create and manage accounts
Create an account
Import accounts and locations from a spreadsheet
Check import status
List your accounts
Get one account
Get an account's plan
Find accounts without an active plan
Edit an account
Assign or change an account's plan
Delete an account and everything under it
Add and manage locations
Add a location
List all locations under your partner
List an account's locations
List locations for a menu
Get one location
Edit a location
Remove a location
Download the locations spreadsheet template
Upload locations for review
Update existing locations from a spreadsheet
Plans and entitlements
List your plans
Get one plan
Get your billing setup
Assign or change an account's plan
Get a location's current plan
List plans visible to an account
Add locations to a plan mid-cycle
Cancel a plan
Cancel a plan (selected locations)
Webhooks
Webhook event catalogue
List the events you can subscribe to
Create a webhook
Send a test event
List your webhooks
Get one webhook
See recent deliveries
Update a webhook
Rotate the signing secret
Show the current secret
Delete a webhook
Error notifications
List open problems
Get one problem
Mark problems resolved or in progress
Add a note to a problem
List a problem's notes
Delete a note
Email a problem to someone
Review Data
Review site catalogue
List supported review sites
List locations with their site connections
Apply one site login to many locations
Get an account's saved site logins
Remove an account's saved site login
Export site setup to a spreadsheet
Import site setup from a spreadsheet
Connect review sites
List a location's review sites
Get one site connection
Set a site's URLs and credentials
Send the business owner a connection link
Get the manager-invite address for a site
Set landing page URLs in bulk
List all URLs for a location
Turn a landing page URL on or off
Turn review collection on or off
Disconnect response posting
Find sites missing a review URL
Get reviews
Get reviews for a location
Get one review
Respond (optional)
Respond to reviews
Post or edit a response
Draft a response with AI
List AI drafts for a review
Remove a response
Insights (optional)
AI insight report
Generate an insight report
Check report status
Get the latest report
List past insight reports
Generate last month's report
Regenerate a report
AI insights summary
Competitive report
List comparison themes
Generate a competitive report
Check report status
List past reports
Solicit Reviews (optional)
Campaigns
Create or edit a campaign
List campaigns
Get one campaign
Duplicate a campaign
Cancel a campaign
Remove a campaign's follow-up
Record private feedback from a customer
Send a customer's comment to the business
Send a review request
Send a review request to a customer
Send a review request from a kiosk
Send a test email to yourself
Send a test text to yourself
Recipients
Upload recipients
List recipients
Email templates
Create an email template
List email templates
Get one email template
Edit an email template
SMS templates
Create a text template
List text templates
Get one text template
Edit a text template
Landing page templates
Create a landing page template
List landing page templates
Get one landing page template
Preview a landing page
Edit a landing page template
QR codes
Create a QR code
List QR codes
Get one QR code
Edit a QR code
Duplicate a QR code
Delete a QR code
QR code templates
Create a QR design
List QR designs
Get one QR design
Edit a QR design
Duplicate a QR design
Delete a QR design
Automated campaigns
List automated campaigns
Define a file format
Get a campaign's file format
Download a sample file
Edit a file format
Delete a file format
Request usage and overage
Email request usage
Text request usage
Review Removal (optional)
Flag a review for removal
Get the reasons a site accepts
Flag a review
Check a flag's status
See flag history
Widgets and display (optional)
Review widget
Load a widget's reviews and settings
List widget styles
FAQ, testimonials, images and widgets
List review widgets
Create or edit a review widget
Delete a review widget
Get FAQs
Save FAQs
Get testimonials
Save testimonials
Get how-it-works content
Save how-it-works content
Get gallery images
Upload gallery images
Delete a gallery image
Branding and white label
Get branding
Set domain and logos
Set colours and theme
Set colours and theme (options + logo)
Remove a logo or favicon
Get email sender status
Set up your email sender domain
White-label emails
List email types
Get an email template
List an email's merge fields
Save an email template
Preview an email
Send a test email
Turn an email type on or off
Choose who sends an email
Show or hide your logo in emails
See email delivery history
Reset an email to the default
Hosted landing page
Configure the hosted page
Remove a hosted page image
Reports (optional)
Partner
Partner reports: performance
Headline numbers
Performance by location
Performance by review site
Lifetime reviews by site
Export to Excel
Export performance report to PDF
Partner reports: stats and activity
Counts
Review and response totals
Sentiment breakdown
Location growth
Recent activity
Partner reports: billing
Billing summary
Billing detail
Billing for one account
Billing for one location
Partner reports: insights, exports and scheduled email reports
AI insights summary
Export locations to Excel
Schedule a partner email report
Edit a partner email report
Schedule an account email report
Edit an account email report
List scheduled reports
Delete a scheduled report
Delete an account email report
Account
Account reports: review and response reports
Headline numbers
Performance by location
Performance by review site
Lifetime reviews by site
Star rating breakdown
Ranking report
Export to Excel
Export performance report to PDF
Account reports: dashboard
Headline counts
Average rating over time
Reviews over time
Responses over time
Response time over time
Review requests over time
Rating breakdown
Reviews by site
Sentiment
This year versus last
Top locations
Monthly ranking
Twelve-month ranking
Twelve-month ranking (explicit window)
List sub-accounts
Account reports: performance
Headline numbers
Performance by location
Performance by review site
Annual volume and rating
List the account's review sites
Export to Excel
Export performance report to PDF
Account reports: ranking
Ranking report
Account reports: campaign reporting
Request totals
Email results for a campaign
Email delivery comparison
Email recipients and status
Email links clicked
Text results for a campaign
Text recipients and status
Text links clicked
Click events for a link
Account reports: QR statistics
Scans by QR code
Scan history for a code
Scans by design
Scan history for a design
Advanced
Users and roles (partner)
List users
Add a partner user
Get one user
Edit a partner user
Users and profile (account)
Add an account user
Get one account user
Edit an account user
Remove a user
Update your own profile
Act as an account owner
Get a token for an account
Get a token for a specific user
Billing address and checkout
Get the billing address
Save the billing address
Preview partner charges
Single sign-on
JumpCloud: start sign-in
JumpCloud: callback
JumpCloud: exchange the code
Verify an SSO token
Check which sign-in methods an email can use
Reference data (countries, states, cities, industries)
List countries
List states
List cities
List industries
Google connection activity report
Google connection activity
AI Tool
MCP
LLM
Powered by
Ranking report
Copy Page
