Deals API
All endpoints require a valid Cloudflare Access JWT.
Base path: /api/deals
Pipeline Templates
Section titled “Pipeline Templates”GET /api/deals/pipeline-templates
Section titled “GET /api/deals/pipeline-templates”List pipeline templates with their stages.
Permission: view:deals
GET /api/deals
Section titled “GET /api/deals”List deals with optional filtering.
Permission: view:deals
| Param | Type | Description |
|---|---|---|
stage_id | query | Filter by pipeline stage |
search | query | Filter by deal name |
POST /api/deals
Section titled “POST /api/deals”Create a deal. Requires can_update on deals.
GET /api/deals/:id
Section titled “GET /api/deals/:id”Get a deal with company, contact, stage, and timeline data.
PUT /api/deals/:id
Section titled “PUT /api/deals/:id”Update a deal. Requires can_update on deals.
DELETE /api/deals/:id
Section titled “DELETE /api/deals/:id”Delete a deal. Requires can_manage on deals.
POST /api/deals/:id/timeline
Section titled “POST /api/deals/:id/timeline”Add a timeline entry to a deal. Requires can_update on deals.
See Also
Section titled “See Also”Companies and contacts endpoints are also served under /api/deals — see the Companies & Contacts API reference.