Skip to main content
GET
Retrieve a pipeline with its stages and attributes

Authorizations

x-api-key
string
header
required

Copy the API key as provided by the Bridge Console.

Path Parameters

workspaceId
string<uuid>
required

Unique identifier of the workspace (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

pipelineId
string
required

Unique identifier of the pipeline, as listed by GET /pipelines.

Required string length: 1 - 255
Example:

"5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10"

Response

Successful Response

A pipeline of the workspace with the stages and attributes of its current version.

id
string
required

Unique identifier of the pipeline.

Example:

"5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10"

label
string
required

Name of the pipeline as shown in Bridge.

Example:

"Sales"

isDefault
boolean
required

Whether a record created without pipelineId goes to this pipeline.

Example:

true

currentVersion
integer
required

Version of the pipeline that new records follow.

Example:

3

acceptsApiRecords
boolean
required

Whether records can be created in this pipeline through the API.

Example:

true

initialStageId
string
required

Stage a record created without stageId starts in.

Example:

"stage-new"

stages
PipelineStageResponse · object[]
required

Stages of the current version, in order.

attributes
PipelineAttributeResponse · object[]

Attributes of the current version.

closeReasons
PipelineCloseReasonResponse · object[]

Reasons a record can be closed with; retired reasons are left out.