Create, import, read, and update CRM leads. All endpoints require a valid
Bearer JWT and are scoped to the
token's project_id. See Add Leads for a full request/response
walk-through.
Endpoints
| Method | Path | Description |
|---|
| POST | /api/leads/add | Create one or more leads. See Add Leads. |
| POST | /api/leads/import | Bulk-import leads (e.g. from a spreadsheet). |
| POST | /api/leads/import/preview | Preview an import before committing. |
| GET | /api/leads/check-mergeable | Detect leads that can be merged (duplicates). |
| POST | /api/leads | List / query leads in the project (filters in the body). |
| GET | /api/leads/{lead_id} | Fetch a single lead by ID. |
| PUT | /api/leads/{lead_id} | Update a lead. |
| POST | /api/leads/test | Create a test lead. |
| GET | /api/leads/test | List test leads. |
Notes
Legacy note endpoints attached to leads. Prefer note activities (see
Activities) for new work.
| Method | Path | Description |
|---|
| POST | /api/leads/notes | Add a note to a lead. |
| PUT | /api/notes/{note_id} | Update an existing note. |
Opportunities & Pipelines
| Method | Path | Description |
|---|
| GET | /api/leads/{lead_id}/opportunities | List opportunities for a lead. |
| GET | /api/opportunity-statuses | List opportunity statuses. |
| GET | /api/pipelines | List sales pipelines. |