Get Pipeline

GET 
/opportunities/pipelines/:pipelineId

Retrieves a single pipeline by its ID, including all its stages and configuration.

Request

Version stringrequired

API Version

Available options2021-04-15

pipelineId stringrequired

The unique identifier of the pipeline

application/json

Successful response

application/json

Schema

Schema

idstring

Unique identifier of the pipeline

namestring

Name of the pipeline

stagesarray[]

Stages belonging to this pipeline

showInFunnelboolean

Whether the pipeline is shown in the funnel view

showInPieChartboolean

Whether the pipeline is shown in the pie chart view

locationIdstring

Identifier of the location (sub-account) this pipeline belongs to

useOpportunityProbabilityboolean

Whether stage-level win probability is enabled for this pipeline

colorRenderModestring
How pipeline/stage colors are rendered
Available optionsdotbg-tintnone
positionstring

Fractional-index key used to sort pipelines. Updated when the user reorders pipelines (via drag-and-drop or the reorder modal).

Example (auto)

{
  "id": "aWdODOBVOlH1RUFKWQke",
  "name": "new pipeline",
  "stages": [],
  "showInFunnel": false,
  "showInPieChart": true,
  "locationId": "VeMHYX28Satp2p7XVKbb",
  "useOpportunityProbability": true,
  "colorRenderMode": "dot",
  "position": "a0V"
}