Back to CRM Overview

CRM API Documentation

Complete API reference with interactive examples. Test endpoints directly with your API key.

API Configuration

Get your API key from CRM Settings → API Access

Found in your CRM instance URL or workspace settings

Table of Contents

1Authentication2Contacts3Deals4Tasks
1

Authentication

API Keys

All API requests require authentication using an API key. Include your API key in the Authorization header.

Authorization Header

Authorization: Bearer sk_crm_your_api_key_here

⚠️ Security: Never expose your API keys in client-side code or public repositories.

2

Contacts

GET/api/contacts

Get all contacts with optional filtering, pagination, and sorting

POST/api/contacts

Create a new contact

GET/api/contacts/:id

Get a specific contact by ID

PUT/api/contacts/:id

Update an existing contact

DELETE/api/contacts/:id

Delete a contact

3

Deals

GET/api/deals

Get all deals with optional filtering, pagination, and sorting

POST/api/deals

Create a new deal

GET/api/deals/:id

Get a specific deal by ID

PUT/api/deals/:id

Update an existing deal

PATCH/api/deals/:id/stage

Update deal stage

4

Tasks

GET/api/tasks

Get all tasks with optional filtering, pagination, and sorting

POST/api/tasks

Create a new task

GET/api/tasks/:id

Get a specific task by ID

PUT/api/tasks/:id

Update an existing task

PATCH/api/tasks/:id/status

Update task status

Ready to Integrate?

Create your API key and start building powerful integrations with your CRM data.

Launch CRM Instance Read Product Guide