Deals API
Manage deals and pipeline stages.
Endpoints
List Deals
http
GET /api/v1/dealsQuery Parameters:
| Parameter | Type | Description |
|---|---|---|
| stage | string | Pipeline stage |
| contactId | string | Filter by contact |
| minValue | number | Minimum deal value |
| maxValue | number | Maximum deal value |
| page | number | Page number |
| limit | number | Per page |
Get Deal
http
GET /api/v1/deals/:idCreate Deal
http
POST /api/v1/dealsjson
{
"name": "Enterprise Contract",
"contactId": "contact-uuid",
"value": 5000,
"currency": "USD",
"stage": "qualified",
"expectedCloseDate": "2026-03-15",
"pipelineId": "pipeline-uuid"
}Update Deal
http
PATCH /api/v1/deals/:idMove Deal Stage
http
PATCH /api/v1/deals/:id/stagejson
{
"stage": "proposal"
}Delete Deal
http
DELETE /api/v1/deals/:id