Skip to main content
GET
Get a pipeline

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Path Parameters

id
string
required

The pipeline ID

Response

successful

id
string
required

The pipeline ID

Example:

"pipeline123xyz"

name
string
required

The name of the pipeline

Example:

"Sales Pipeline"

audience_types
enum<string>[]
required

Record audiences supported by this pipeline

Available options:
prospect,
client,
contact,
business
pipeline_type
enum<string> | null

Deprecated legacy pipeline type for client/prospect-only pipelines

Available options:
prospect,
client
Example:

"prospect"

default_pipeline_types
enum<string>[]

Legacy default client/prospect types served by this pipeline

Available options:
prospect,
client
book_id
string | null

The book ID

Example:

"book123xyz"

pipeline_stages
object[]

Ordered pipeline stages