Pipelines & Opportunities API

Pipelines, their stages, and opportunities power the sales kanban. All endpoints are org-scoped via X-Org-Id. Routes live under /api/v1.

Pipelines

Method	Path	Description
GET	/pipelines	List pipelines.
POST	/pipelines	Create a pipeline (201).
PATCH	/pipelines/{pipeline_id}	Update a pipeline (and its stages).
DELETE	/pipelines/{pipeline_id}	Delete a pipeline.
GET	/pipelines/{pipeline_id}/board	Get the kanban board (server-filtered, optionally with weighted forecast).

Opportunities

Method	Path	Description
GET	/opportunities	List opportunities (org-scoped).
GET	/opportunities/{opportunity_id}	Get one opportunity.
PATCH	/opportunities/{opportunity_id}	Update an opportunity (move stage, set value, assign, set forecast probability or lost reason).
DELETE	/opportunities/{opportunity_id}	Delete an opportunity.

Opportunities carry a forecast_probability; stages carry a win_probability. The weighted forecast on the board is computed from these (behind the opportunities.forecast feature flag). Opportunities also carry created_by / updated_by actor attribution.

Lost reasons

A per-org registry of lost reasons that can be set on a closed-lost opportunity:

Method	Path	Description
GET	/lost-reasons	List lost reasons.
POST	/lost-reasons	Create a lost reason (201).
PATCH	/lost-reasons/{reason_id}	Update a lost reason.
DELETE	/lost-reasons/{reason_id}	Delete a lost reason.

Note

The flat GET /opportunities and GET /opportunities/{id} reads were added in the object- associations wave. Some integrations fall back to the kanban board endpoint when the flat routes are not available on an older API version.