ReferenceStages
Stages
Pipeline columns. Only open is a public PATCH target.
Optional query pipeline_id. Response { "data": [ … ] }, not a cursor page. Use id as deal.stage.
| HTTP | Path | Scope |
|---|---|---|
| GET | /api/v1/stages | rest.crm.deals.read |
Query
| Parameter | Type | Notes |
|---|---|---|
| pipeline_id | UUID | Optional. Filter one pipeline. |
Fields
| Field | Type | Notes |
|---|---|---|
| id | UUID | Use as deal.stage. |
| name | string | Product label (Qualified). |
| type | open | won | lost | Only open is a public PATCH target. |
| position | number | Board order. |
| pipeline_id | UUID | Owning pipeline. |
| pipeline_name | string | Pipeline name. |
| default_pipeline | boolean | Org default pipeline. |