Back to API Documentation

Quick Start Guide

Get up and running with the Cheers API.

1

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.

2

Make Your First Request

Test your API key by fetching your organization's reviews:

cURL Request
curl -X GET "https://app.cheers.tech/api/public/v1/reviews?organization_id=123" \
  -H "Authorization: Bearer YOUR_API_KEY"
3

Handle the Response

The API returns JSON responses. Here's an example response:

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"
  }
]
4

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 Support