Deals API

List Deals

GET /api-deals

Parameters

Parameter	Type	Description
`page`	integer	Page number (default: 1)
`per_page`	integer	Items per page (default: 25, max: 100)
`status`	string	Filter: `open`, `on_hold`, `closed_won`, `closed_lost`
`contact_id`	uuid	Filter by associated contact
`sort`	string	Sort field (default: `created_at`)
`order`	string	Sort order: `asc` or `desc`

Response

{
  "data": [
    {
      "id": "uuid",
      "title": "Enterprise License",
      "value": 50000,
      "currency": "USD",
      "status": "open",
      "stage": "Proposal",
      "contact_id": "uuid",
      "expected_close_date": "2026-04-15",
      "probability": 75,
      "created_at": "2026-01-15T10:30:00Z"
    }
  ],
  "count": 1
}

Create Deal

POST /api-deals

Body

{
  "title": "Enterprise License",
  "value": 50000,
  "currency": "USD",
  "stage": "Qualified",
  "contact_id": "uuid",
  "expected_close_date": "2026-04-15"
}

Required Fields

title

Update Deal

PATCH /api-deals?id=<deal_id>

Delete Deal

DELETE /api-deals?id=<deal_id>

On this page