Getting Started
Get started with the CRMchat API
CRMchat API is currently in Beta
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.
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/v1Quick Start
1. Get your API key
Go to CRM Settings and generate a new API key. The key is only shown once — store it somewhere safe.
2. Make a request
Try listing your organizations — the simplest call you can make:
curl -H "Authorization: Bearer sk_your_api_key" \
https://api.crmchat.ai/v1/organizations3. Explore the API
Authentication
API keys, rate limits, and security best practices
Pagination
Cursor-based pagination across all list endpoints
Updating Resources
How partial updates work with JSON Merge Patch
Custom Properties
Define custom fields on contacts for your workflow
OpenAPI Spec
The full OpenAPI 3.x specification is available at /v1/spec.json. Use it to generate client libraries, import into Postman, or integrate with any OpenAPI-compatible tooling.
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 | Concise overview with links to sections |
| llms-full.txt | /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).