Documentation Index
Fetch the complete documentation index at: https://docs.heffl.com/llms.txt
Use this file to discover all available pages before exploring further.
API Reference
The Heffl API lets you programmatically access and manage your CRM, sales, and project data. Use it to build custom integrations, sync data with external systems, or automate workflows.
Base URL
https://api.heffl.com/api/v1
Authentication
Every request must include your API key in the x-api-key header:
curl https://api.heffl.com/api/v1/leads \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"
- All request bodies must be JSON with
Content-Type: application/json
- Query parameters are used for filtering and pagination on list endpoints
- Resource IDs in URLs are string-based public IDs (e.g.,
ld_abc123) across business entities (leads, clients, deals, tasks, invoices, webhooks).
Example: Create a lead
curl -X POST https://api.heffl.com/api/v1/leads \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Jane Smith",
"email": "[email protected]",
"mobile": "+1234567890",
"title": "Product Demo Request"
}'
{
"id": "ld_abc123",
"name": "Jane Smith",
"email": "[email protected]",
"createdAt": "2025-01-15T10:30:00.000Z"
}
{
"items": [...],
"nextCursor": "cursor_value_or_null",
"hasMore": true
}
| Parameter | Type | Default | Description |
|---|
cursor | string | none | Cursor returned by the previous response |
limit | number | 20 | Items per response (max 100) |
curl "https://api.heffl.com/api/v1/leads?limit=25" \
-H "x-api-key: YOUR_API_KEY"
Error handling
Error responses include a descriptive message:
{
"code": "BAD_REQUEST",
"message": "Invalid email address format"
}
Error codes
| Code | HTTP Status | Description |
|---|
UNAUTHORIZED | 401 | Missing or invalid API key |
FORBIDDEN | 403 | API key valid but lacks permission |
NOT_FOUND | 404 | Resource does not exist |
BAD_REQUEST | 400 | Invalid request parameters |
TOO_MANY_REQUESTS | 429 | Rate limit exceeded |
Rate limiting
API requests are rate limited to 60 requests per minute per API key. If you exceed the limit, you’ll receive a 429 response with RateLimit-* headers indicating your current usage and reset time. Include retry logic with exponential backoff in your integration.
Custom fields
Entities that support custom fields (leads, deals, clients, invoices) accept them via the cf_ prefix in create and update requests:
{
"name": "Jane Smith",
"email": "[email protected]",
"cf_industry": "Technology",
"cf_company_size": "50-100"
}
cf_).
Available resources
CRM
| Resource | Operations |
|---|
| Leads | Create, List, Get, Update, Delete |
| Clients | Create, List, Get, Update, Delete |
| Deals | Create, List, Get, Update, Delete |
| Tasks | Create, List, Get, Update, Delete |
Reference data
| Resource | Operations |
|---|
| Tags | List |
| Pipelines | List, Get |
| Products | List, Get |
| Lead Stages | List |
| Lead Sources | List |
Webhooks
| Resource | Description |
|---|
| Webhooks | Setup, security, delivery |
| Webhook Events | Event catalog with payloads |
- cURL for command-line testing
- Postman for interactive exploration
- Zapier / Make for no-code integrations
- Any HTTP library in your programming language of choice
