Skip to content

Get Pipeline

GET
/pipelines/{pipeline_id}

Get one pipeline by ID, with stages including v2 fields.

Authorizations

Parameters

Path Parameters

pipeline_id
required
string

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
id
required
string
is_default
boolean
name
required
string
stages
Array<object>
default:
object
channel_scripts
object
key
additional properties
string
color
Any of:
string
id
required
string
name
required
string
position
Any of:
integer
probability
Any of:
integer
recommended_elements
Array<string>
required_elements
Array<string>
stage_type
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string