Skip to navigation
Sales CRMDeals

Get a pipeline

View as Markdown
Retrieve the details of a specific deal pipeline by its identifier, including its stages, stage ordering, and configuration. Use this endpoint to obtain the pipeline and stage IDs needed when creating or updating deals.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app's client_id/client_secret for a short-lived Bearer token.

Path parameters

pipelineIDstringRequired

Response

Returns pipeline and its details
pipelinestringOptional
Pipeline id
pipeline_namestringOptional
Pipeline Name
stageslist of objectsOptional
List of pipeline stages

Errors

400
Bad Request Error