Pipelines API
The Pipeline and Stage objects A workspace has one or more deal pipelines. Each pipeline has an ordered list of stages, and each deal sits in one stage. A stage can be flagged won or lost, which is how reports know a deal is closed.
Field Type Notes idstring The pipeline ID namestring Up to 80 characters isDefaultboolean true for the pipeline every workspace starts withorderinteger Position among pipelines stagesarray of Stage In board order createdAt, updatedAtstring (ISO 8601) Timestamps
Field Type Notes idstring The stage ID namestring Up to 60 characters orderinteger 0-based position on the board wonboolean Deals here count as won lostboolean Deals here count as lost. Never both won and lost dealCountinteger Deals currently in this stage
{ "id" : "cmq5pipe0alk34567890" , "name" : "Sales Pipeline" , "isDefault" : true , "order" : 0 , "createdAt" : "2026-06-01T10:00:00.000Z" , "updatedAt" : "2026-09-27T14:02:00.000Z" , "stages" : [ { "id" : "cmq5stg00alk34567890" , "name" : "New" , "order" : 0 , "won" : false , "lost" : false , "dealCount" : 12 }, { "id" : "cmq5stg10alk34567890" , "name" : "Qualified" , "order" : 1 , "won" : false , "lost" : false , "dealCount" : 8 }, { "id" : "cmq5stg20alk34567890" , "name" : "Won" , "order" : 2 , "won" : true , "lost" : false , "dealCount" : 20 }, { "id" : "cmq5stg30alk34567890" , "name" : "Lost" , "order" : 3 , "won" : false , "lost" : true , "dealCount" : 9 } ] } Scope Allows read:pipelinesGET /api/v1/pipelines and GET /api/v1/pipelines/{id}write:pipelinesCreate, rename and delete pipelines, and add, update, reorder and delete stages