Check Cherry Business API (v1)

Base URL — All API requests should be made to:

https://api.checkcherry.com/api/v1/

All endpoints in this documentation are relative to this base URL.

Setup:

1. Log in to your Check Cherry account
2. Navigate to Manage → Business Settings → Integrations
3. Create a new Integration Key
4. Copy the key (it starts with ik_) and use it to authenticate your requests

Each integration key is tied to a specific user, providing an audit trail and user-level permissions. You can create multiple keys and revoke them individually.

Versioning & Stability — This API is under active development. The API surface will evolve as we ship new features and improve existing ones. Please build your integrations with this in mind:

• Additive changes happen without notice. New fields, endpoints, and optional parameters may appear at any time. Your integration should ignore unknown fields rather than breaking on them.
• We will try to give 30 days notice for breaking changes (removing or renaming fields, changing response structure, removing endpoints), but this is best-effort, not a guarantee.
• Build defensively. Don't assume field lists are frozen. Don't break on unknown fields or new enum values.

Pass your integration key as an Api-Key HTTP header with every request:

curl -H "Api-Key: ik_your_key_here" https://api.checkcherry.com/api/v1/leads

The key identifies both the business and the user automatically.

Security:

• Your key is your identity. Anyone with your integration key has full access to your Check Cherry account. You are responsible for all activity that occurs using your key.
• Keep your key secret. Never expose integration keys in client-side code, public repositories, or anywhere they could be accessed by unauthorized parties.
• HTTPS only. All API requests must be made over HTTPS. Plain HTTP requests will be rejected.
• Rotate and revoke. If a key may have been compromised, revoke it immediately from Business Settings and create a new one. Don't reuse keys across unrelated integrations.
• Store keys securely. Use environment variables or a secrets manager — never commit keys to source control or store them in plain text.
• Monitor usage. Keys track last-used timestamps. Review your active keys periodically and revoke any that are no longer in use.

Check Cherry reserves the right to revoke any API key or suspend any account that appears to be compromised, is being used in violation of our terms of service, or is abusing the platform. This includes but is not limited to excessive requests, unauthorized data access, or any activity that degrades the service for other users.

Request format — Send JSON request bodies with the Content-Type: application/json header for POST, PUT, and PATCH requests.

Response format — All responses follow the JSON:API format:

{
  "data": {
    "id": "123",
    "type": "lead",
    "attributes": { "first_name": "Jane", "email": "jane@example.com" },
    "relationships": { ... }
  }
}

Error responses use this structure:

{
  "meta": { "status": "error" },
  "status": "unauthorized",
  "reason": "api_key_missing",
  "message": "API key is required"
}

Pagination — List endpoints support pagination via page and per query parameters. Responses include a meta object with pagination details:

{
  "data": [ ... ],
  "meta": { "total_count": 142, "per_page": 25, "page": 1, "total_pages": 6 }
}

Stop paging once page reaches total_pages. Requesting a page beyond the end of the result set is not useful, and the search index cannot reach past the first 10,000 results however you page to them.

This API is versioned v1 and that version does not move — we add endpoints and fields rather than break integrations that work. New endpoints, new fields, and newly documented behavior are listed at checkcherry.com/api/changelog.

Check Cherry support can help with:

• Account and billing issues
• Integration key management (creating, revoking)
• Reporting bugs or unexpected behavior in the API

Check Cherry support cannot help with:

• Building or designing your custom integration
• Debugging your application code
• Troubleshooting third-party libraries or frameworks

You are responsible for developing and maintaining your own integrations. These API docs include endpoint descriptions, parameter details, and response examples — we recommend using them alongside AI coding assistants (such as ChatGPT or Claude) to help build and troubleshoot your integration.

For platform issues, contact support@checkcherry.com.

Rate limiting — Check Cherry enforces rate limits on API requests. Specific limits may vary based on your plan and endpoint, but typical usage should not encounter them. If the rate limit is exceeded, Check Cherry returns a 403 Forbidden with an associated "Rate Limit Exceeded" message. Back off and retry after a brief delay. Intentional or repeated abuse of rate limits may result in your API key being revoked or your account being suspended.

Leads represent potential customer inquiries — someone who has expressed interest in booking an event but hasn't yet committed. A lead captures contact information, event preferences, venue details, and any messages from the initial inquiry.

Use the Leads API to push inquiries from external sources (your website, third-party platforms, advertising campaigns) into Check Cherry, where they enter the business's sales pipeline. Leads can be assigned to staff members for follow-up, filtered and searched, and eventually converted into confirmed events.