> ## Documentation Index
> Fetch the complete documentation index at: https://help.ciarem.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> How the endpoint reference is organized, and where to start.

Every endpoint below is generated from the live contract, so what you read here is what the API serves.

**Base URL** `https://api.ciarem.ai` · **Auth** `Authorization: Bearer oak_…` on every request ([how to get a key](/api-reference/authentication)).

## How it's organized

| Group                  | What's in it                                                          |
| ---------------------- | --------------------------------------------------------------------- |
| **Account**            | Who the key belongs to — organization, plan, timezone, language.      |
| **Contacts**           | People in your CRM. Full CRUD.                                        |
| **CRM**                | The *shape* of your CRM: custom properties and funnel stages.         |
| **Conversations**      | Read message history.                                                 |
| **WhatsApp numbers**   | The numbers a send can go out from.                                   |
| **WhatsApp templates** | Your templates, and what each one needs filled before it can be sent. |
| **Broadcasts**         | Send a template, then follow what happened to every recipient.        |

## Where to start

<CardGroup cols={2}>
  <Card title="Send your first message" icon="paper-plane" href="/api-reference/broadcasts/send-a-template">
    Check `send-requirements` first, then send to one recipient or a hundred in a single call.
  </Card>

  <Card title="Errors, limits, and pagination" icon="triangle-exclamation" href="/api-reference/errors-limits-pagination">
    The error vocabulary, the rate-limit headers, and how to retry safely.
  </Card>
</CardGroup>

<Note>
  The API is early and moves fast. Changes are additive — new endpoints, new optional parameters, new response fields and new string values — so tolerate unknown fields rather than validating strictly. Everything that changes lands in the [changelog](/api-reference/changelog).
</Note>