# Getting Started (/docs)





<Callout title="CRMchat API is currently in Beta" type="warn">
  While we do our best to keep things stable, endpoints and response shapes may occasionally change
  during the beta period. If you run into any issues, please reach out to
  [@rudnikov](https://telegram.me/rudnikov).
</Callout>

The CRMchat API gives you programmatic access to your contacts, organizations, workspaces, custom properties, and more. It follows REST conventions with JSON requests and responses.

**Base URL:**

```
https://api.crmchat.ai/v1
```

## Quick Start [#quick-start]

### 1. Get your API key [#1-get-your-api-key]

Go to [CRM Settings](https://app.crmchat.ai/mini-app/settings/api-keys) and generate a new API key. The key is only shown once — store it somewhere safe.

### 2. Make a request [#2-make-a-request]

Try listing your organizations — the simplest call you can make:

```bash
curl -H "Authorization: Bearer sk_your_api_key" \
  https://api.crmchat.ai/v1/organizations
```

### 3. Explore the API [#3-explore-the-api]

<Cards>
  <Card href="/docs/authentication" title="Authentication" icon="<KeyRound />">
    API keys, rate limits, and security best practices
  </Card>

  <Card href="/docs/pagination" title="Pagination" icon="<List />">
    Cursor-based pagination across all list endpoints
  </Card>

  <Card href="/docs/patching-resources" title="Updating Resources" icon="<Pencil />">
    How partial updates work with JSON Merge Patch
  </Card>

  <Card href="/docs/api/custom-properties" title="Custom Properties" icon="<SlidersHorizontal />">
    Define custom fields on contacts for your workflow
  </Card>
</Cards>

## OpenAPI Spec [#openapi-spec]

The full OpenAPI 3.x specification is available at [`/v1/spec.json`](https://api.crmchat.ai/v1/spec.json). Use it to generate client libraries, import into Postman, or integrate with any OpenAPI-compatible tooling.

## AI & LLM Integration [#ai--llm-integration]

The CRMchat API docs are available in machine-readable formats for AI agents and LLM-powered tools:

| Format        | URL                                                             | Description                             |
| ------------- | --------------------------------------------------------------- | --------------------------------------- |
| llms.txt      | [`/llms.txt`](https://developers.crmchat.ai/llms.txt)           | Concise overview with links to sections |
| llms-full.txt | [`/llms-full.txt`](https://developers.crmchat.ai/llms-full.txt) | Complete documentation in a single file |

You can also view any page as raw Markdown by appending `.mdx` to its URL (e.g. `/docs/authentication.mdx`).