Base URL
All API requests use the following base URL:Request format
- All request bodies must be JSON with
Content-Type: application/json - File uploads use
Content-Type: multipart/form-data - UUIDs are used for all resource identifiers
Authentication
Include your API key in every request:Response format
All responses return JSON. Successful responses return the resource directly or a paginated wrapper:Common patterns
| Pattern | Example |
|---|---|
| List resources | GET /api/contacts?page=1&page_size=25 |
| Get by ID | GET /api/contacts/{id} |
| Create | POST /api/contacts |
| Update | PUT /api/contacts/{id} |
| Delete | DELETE /api/contacts/{id} |
| Bulk delete | POST /api/contacts/bulk-delete |
Endpoint groups
| Group | Prefix | Description |
|---|---|---|
| Contacts | /api/contacts | People in your CRM |
| Companies | /api/companies | Organizations and teams |
| Deals | /api/deals | Sales pipeline deals |
| Activities | /api/activities | Calls, meetings, tasks |
| Notes | /api/notes | Notes on entities |
| Favorites | /api/favorites | Bookmarked records |
| Email Drafts | /api/email-drafts | Email drafts |
| Email Templates | /api/email-templates | Email templates |
| Knowledge Base | /api/kb | KB documents |
| Chats | /api/chats | AI chat conversations |