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

# API Overview

> Use the ChatFlows REST API to connect your website, CRM and other business systems to your workspace, so they work together automatically.

## What you can do

> [card] Sync customers
>
> Create and update customers from your other business systems.

> [card] Send WhatsApp messages
>
> Send template messages and replies to your customers.

> [card] Read conversations
>
> View chats and message history in your other business systems.

> [card] Verify phone numbers
>
> Send a one-time code on WhatsApp and confirm it.

## Get started

**1. Create an API key**

Go to [Setup → Developer API Keys](https://docs.chatflows.io/core-setup/api-keys.md) and click **Add Token**. Enter a name, select the permissions it needs, and copy the key. The key is shown only once.

**2. Connect your business system**

Add your API key and the base URL below to your other business system.

```text Base URL theme={null}
https://app.chatflows.io/api/v1
```

**3. Test the connection**

Send a request to [Ping](https://docs.chatflows.io/api-reference/auth-&-account/ping.md). A successful response confirms your API key is set up correctly.

## Permissions and security

* **Choose only the permissions you need.** Each API key has its own permissions, such as viewing customers or sending messages. Select only what your business system uses.
* **Keep your API keys secure.** Anyone who has a key can access your workspace data. Store it safely and never share it in emails, chats or public places.
* **Revoke keys you no longer use.** If a key is no longer needed or may have been exposed, revoke it from the [Developer API Keys](https://docs.chatflows.io/core-setup/api-keys.md) page. It stops working immediately.

## Error codes

| Code | Meaning | What to do |
| - | - | - |
| `401` | The API key is missing, invalid or expired. | Check the key, or create a new one. |
| `402` | The workspace has no active subscription. | Review [Plan & Billing](https://docs.chatflows.io/billing/plan-and-billing.md). |
| `403` | The API key doesn't have the required permission. | Create a key with the missing permission. |
| `404` | The record or address doesn't exist. | Check the ID or URL. |
| `422` | Some data is missing or invalid. | The error message names the field to fix. |
| `429` | Too many requests, or the monthly limit is reached. | Wait and retry. |

## Developer resources

> [card] [Interactive API reference](https://app.chatflows.io/api-docs)
>
> Test every endpoint live with your API key.

> [card] [Postman collection](https://docs.chatflows.io/core-setup/api-keys.md)
>
> Download it from the **Developer API Keys** page.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.