Using the Check Cherry API

If you want Check Cherry to talk to other software you use, the Check Cherry API is how you do it. It gives programmatic access to your events, leads, bookings, payments, and more, so you can connect Check Cherry to the rest of the tools you run your business on.

Who it's for

The API is a developer tool. Using it means writing and running code, not clicking through the app. That used to mean hiring a developer. It still can, but AI coding assistants like Claude Code, Cursor, and ChatGPT have lowered the bar a lot. If you are comfortable following technical steps, you can often get a working integration going yourself. Just know it is more hands-on than the no-code options below, which is all most businesses ever need.

If you are not a developer: Zapier lets you connect Check Cherry to hundreds of other apps — like Google Sheets, Mailchimp, or your CRM — without writing any code. For pointing an AI assistant like ChatGPT or Claude at your account so it can read your data and draft work for you, use the AI assistant connection instead. Reach for the API only when you want to build your own custom integration.

Common reasons businesses build on the API:

  • Sync events or bookings into another system you already use
  • Pull leads or payment data into your own reporting or accounting setup
  • Automate a workflow that would otherwise be manual data entry
  • Connect Check Cherry to an internal tool you have built

For the complete list of what is available, including every endpoint, parameter, and example response, see the full reference at checkcherry.com/api/docs. That reference is the source of truth and stays current as the API grows.

Getting an integration key

Every request to the API is authenticated with an integration key. Each key is tied to a specific user on your account, which gives you a clean audit trail and means the key inherits that user's permissions. You can create more than one key and revoke any of them individually, so it is common to use a separate key for each integration.

ManageBusiness SettingsIntegrationsAPI Overview
Go to API Overview under Business Settings, then Integrations.
Create a new Integration Key.
When setting up the key, grant only the specific permissions your integration actually needs — read-only if it only reads data, nothing more.
Copy the key (it starts with ik_) and store it somewhere safe.
Treat your integration key like a password. Never put it in client-side code, a public repository, or anywhere a customer could see it. If a key is ever exposed, revoke it and create a new one.

Building your integration

Share these basics with your developer. Everything else, including the endpoint list and response formats, is in the full reference.

  • Base URL: https://api.checkcherry.com/api/v1/
  • Authentication: send the key as an Api-Key header on every request. HTTPS only.
  • Format: requests and responses use JSON:API. List endpoints paginate with page and per.

A minimal authenticated request looks like this:

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

The API is under active development. New fields and endpoints can be added at any time, so build defensively: have your integration ignore fields it does not recognize rather than break on them. We aim to give around 30 days of notice for changes that could break existing integrations, but designing for change is the safest approach.

The full reference works well alongside an AI coding assistant. Pasting an endpoint's docs into ChatGPT or Claude is a fast way to scaffold the first working request.

What support can help with

The Check Cherry team is happy to help with the parts of the API that are ours to support:

In short, you own your integration. If you hit something that looks like a platform issue or an API bug, start the chat (the chat bubble in the lower right) and we will take a look.

Was this article helpful?

Thanks for your feedback!

Sorry to hear that. Want to chat with our support team?

Chat with us

Last updated June 02, 2026 14:02