v1

latestOpenAPI 3.0.12026-07-268028223.9 KB

Pipelines

Get a pipeline

Retrieve a pipeline by ID. Pipeline stages are returned in order and include stage_order, visible, and default_probability.

get/v1/pipelines/{id}

Path parameters

idstring required

The pipeline ID

Response

successful

idstring required

The pipeline ID

namestring required

The name of the pipeline

pipeline_type'prospect' | 'client' nullable

Deprecated legacy pipeline type for client/prospect-only pipelines

audience_typesstring[] required

Record audiences supported by this pipeline

default_pipeline_typesstring[]

Legacy default client/prospect types served by this pipeline

book_idstring nullable

The book ID

Example response

{
  "id": "pipeline123xyz",
  "name": "Sales Pipeline",
  "pipeline_type": "prospect",
  "book_id": "book123xyz",
  "pipeline_stages": [
    {
      "id": "stage123xyz",
      "name": "Qualified",
      "stage_order": 1,
      "visible": true,
      "default_probability": 50
    }
  ]
}