> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://breakcold-aicrm.crisp.help/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# API

Build your own integrations on top of Breakcold with the **REST API**. Read and write records, tasks, notes and inbox data from your own code, scripts or automation platform.

> If you want an AI agent (Claude, ChatGPT, Cursor…) to run your CRM without writing code, use the [MCP](https://breakcold-aicrm.crisp.help/en/category/settings-1yp6rs3/) instead. The API is for developers building custom integrations.

## Base URL
```
https://rest.breakcold.com/api/v1
```

## Create an API key
1. Go to **Settings → API keys**.
2. Click **Create key**.
3. Give it a descriptive **name** (e.g. "Zapier records sync").
4. Select the **scopes** it needs — start with the minimum, such as *Read records*.
5. Optionally set a **workspace limit** (leave empty for all workspaces) and an **expiration** (30 days for testing, longer for trusted automations).
6. Click **Create personal key** and **copy it immediately**.

||| Warning — Breakcold shows the full key only once. After you close the dialog you can only see its prefix and activity history. Store it somewhere safe.

## Authenticate
Send your key as a Bearer token in the `Authorization` header:
```
Authorization: Bearer YOUR_API_KEY
```

Example request:
```sh
curl "https://rest.breakcold.com/api/v1/records?workspaceId=YOUR_WORKSPACE_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

## What you can do
The v1 API covers the core of your workspace:
* **Records** — create, read, update, archive and restore People, Companies and Deals
* **Tasks** — create, update, complete and delete
* **Notes** — create, read, update and list record-linked notes
* **Inbox** — conversations, messages, views and drafts
* **CRM** — objects, fields and views
* **Meetings** — get, list and read transcripts
* **Webhooks** — subscribe to changes on records, notes, tasks, relations, calls and files

| Note — There is no permanent delete in v1. Use **archive** and **restore** instead.

## Token costs
API calls use the same tokens as the rest of Breakcold: most successful **reads cost ≈ 0.2 tokens** and **writes ≈ 0.4 tokens**. Check each endpoint's pricing before scaling up, and see [What are Tokens Used For?](https://breakcold-aicrm.crisp.help/en/article/what-are-tokens-used-for-10z6aeh/).

## Learn more
* [API overview](https://docs.breakcold.com/api/overview)
* [Authentication](https://docs.breakcold.com/api/authentication)
* [Rate limits](https://docs.breakcold.com/api/rate-limits)
* [Webhooks guide](https://docs.breakcold.com/api/webhooks)
* [API changelog](https://docs.breakcold.com/api/changelog)
* Full endpoint reference: [Records](https://docs.breakcold.com/api-reference/records/), [Tasks](https://docs.breakcold.com/api-reference/tasks/), [Notes](https://docs.breakcold.com/api-reference/notes/), [Inbox](https://docs.breakcold.com/api-reference/inbox/)
* [OpenAPI spec](https://docs.breakcold.com/api/openapi.json)

## Frequently Asked Questions
**Where do I find my workspace ID?**
Most endpoints take a `workspaceId` query parameter. You can list the workspaces your key can access via the [workspaces endpoint](https://docs.breakcold.com/api-reference/workspaces/list-authorized-workspaces).

**Can I restrict a key to one workspace?**
Yes — set a workspace limit when creating the key, and only grant the scopes the integration actually needs.

**What happens if I lose my key?**
You can't recover it — Breakcold only shows it once. Create a new key and delete the old one.

**API vs. MCP — which should I use?**
Use the **API** to build custom code integrations. Use the [**MCP**](https://breakcold-aicrm.crisp.help/en/category/settings-1yp6rs3/) to let AI agents like Claude and ChatGPT operate your CRM in plain English. Both share the same permissions, data and token pricing.