Quick Start Guide
Get up and running with the Cheers API.
Get Your API Key
Log into your Cheers dashboard and navigate to Settings > API. Click "Generate API Key" to create your first key.
Important: Keep your API key secure. Never expose it in client-side code or public repositories.
Make Your First Request
Test your API key by fetching your organization's reviews:
curl -X GET "https://app.cheers.tech/api/public/v1/reviews?organization_id=123" \
-H "Authorization: Bearer YOUR_API_KEY"Handle the Response
The API returns JSON responses. Here's an example response:
[
{
"id": 5678,
"created_at": "2024-06-10T12:00:00Z",
"rating": 5,
"review_text": "Amazing service! John was incredibly helpful.",
"organization_id": 123,
"source": "GOOGLE",
"reviewer_name": "Jane D.",
"card_id": "550e8400-e29b-41d4-a716-446655440000"
}
]Explore More Endpoints
The Cheers API provides access to organizations, cards (badges), taps, links, and more. Check out the full API documentation to see all available endpoints.
Next Steps
- Explore the full API documentation
- Set up date filtering to sync only new reviews
- Use pagination for large datasets
Need help getting started? Our team is here to help.
Contact SupportAgent and crawler context
Make integrations easier to understand.
These guides cover the machine-readable context around the API: structured data, crawler access, llms.txt, and booking paths that agents can inspect.
Can AI Agents Book Appointments From Your Website?
How multi-location service brands should make booking paths, forms, location details, and structured data usable for customers, crawlers, and AI agents.
Open guideTechnicalWhat Is JSON-LD? The Technical Foundation of GEO
JSON-LD is how you give search engines and AI systems clean structured facts about your business. Here's what it is and why it matters.
Open guideTechnicalWhich AI Crawlers Should Local Businesses Allow?
A robots.txt and crawler-access guide for service brands that want AI visibility without opening every page to training crawlers.
Open guideTechnicalWhat Is LLMs.txt, and Should Your Business Use One?
LLMs.txt is an emerging Markdown proposal for giving AI tools a concise site guide. Here's what it is, what it is not, and how local businesses can use it.
Open guide