Skip to main content

API Reference

Deals API

Track opportunities through custom pipeline stages with forecasting.

Endpoints

GET/dealsList all deals

POST/dealsCreate a deal

GET/deals/{id}Get deal details

PUT/deals/{id}Update deal

POST/deals/{id}/moveMove to stage

Create Deal

Request

POST /crm/v1/deals
Content-Type: application/json

{
  "name": "Enterprise Contract - Acme Corp",
  "value": 125000,
  "currency": "USD",
  "stage_id": "stage_proposal",
  "contact_id": "contact_abc123",
  "company_id": "company_xyz",
  "probability": 60,
  "expected_close_date": "2025-01-15",
  "owner_id": "user_123"
}

Next Steps

Activities API

Log deal activities

Webhooks

Deal event notifications