Skip to main content
The Ciarem API lets you connect Ciarem to your own systems: sync contacts, manage your CRM properties and funnel stages, and read conversations programmatically. It is available on the Growth and Scale plans, and during the free trial so you can try it before you pay.
You don’t need the API to use Ciarem. Everything in the product works without writing code. Reach for the API when you want to integrate Ciarem with tools we don’t connect to natively.

​
1. Create an API key

You need to be an admin, on a Growth or Scale plan, or a free trial.
1

Open API keys

In the dashboard, go to Settings, then API keys.
2

Click Create key

Give the key a name that says which integration it is for.
3

Copy the secret

The secret starts with oak_ and is shown only once: copy it right away and store it like a password. If you lose it, revoke the key and create a new one.

​
2. Make your first request

Every request authenticates with the key as a bearer token:
A successful response identifies the organization the key belongs to:

​
3. Explore

  • Create and update contacts, including your custom properties: see the API reference.
  • Read conversations and messages. Every message tells you who spoke: the sender field is contact, agent, ai, or system.
  • Manage CRM metadata: custom properties and funnel stages, the same ones your team uses in the dashboard.
  • Receive webhooks: have Ciarem call your server when a contact, conversation, or message changes, instead of polling. See Webhooks.
Continue with Authentication and Errors, limits, and pagination.