Opportunities API

List Opportunities


GET /api/v1/opportunities

Scope: opportunities:read

Query Parameters

Param	Type	Description
`limit`	number	Max results (default 50, max 100)
`offset`	number	Pagination offset

Response


{
  "opportunities": [
    {
      "id": "uuid",
      "name": "Acme Corp — AI Assessment",
      "stage": "qualified",
      "value": 25000,
      "probability": 70,
      "close_date": "2026-04-30",
      "lead_source": "website",
      "next_step": "Send proposal",
      "contact_id": "uuid",
      "account_id": "uuid",
      "custom_fields": {},
      "created_at": "2026-03-26T10:00:00Z"
    }
  ],
  "total": 25
}

Create Opportunity


POST /api/v1/opportunities

Scope: opportunities:write

Request Body


{
  "name": "Deal Name",
  "contact_id": "uuid",
  "account_id": "uuid",
  "stage": "qualified",
  "value": 50000,
  "close_date": "2026-05-15",
  "probability": 70,
  "lead_source": "referral",
  "description": "Details about the deal",
  "next_step": "Send proposal",
  "custom_fields": {}
}

Only name is required.

Update Opportunity


PATCH /api/v1/opportunities/:id

Scope: opportunities:write

Request Body


{
  "stage": "closed_won",
  "value": 55000,
  "closed_at": "2026-04-01T00:00:00Z",
  "lost_reason": null
}