pipelines

4 endpoints at a glance

Method	Path	Summary
GET	/pipelines	List Pipelines
GET	/pipelines/{pipeline_id}	Get Pipeline
PATCH	/pipelines/{pipeline_id}	Update Pipeline
GET	/pipelines/default	Get Default

pipelines

---

List Pipelines

GET

/pipelines

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/pipelines

Playground

Headers

authorization

Samples

---

Get Default

GET

/pipelines/default

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/pipelines/default

Playground

Headers

authorization

Samples

---

Get Pipeline

GET

/pipelines/{pipeline_id}

Parameters

Header Parameters

authorization

Path Parameters

pipeline_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/pipelines/{pipeline_id}

Playground

Headers

authorization

Variables

Key

Value

pipeline_id*

Samples

---

Update Pipeline

PATCH

/pipelines/{pipeline_id}

Parameters

Header Parameters

authorization

Path Parameters

pipeline_id*

Type

string

Required

Request Body

application/json

{

  

"name": "string",

  

"stages": [

  

  

{

  

  

  

"id": "string",

  

  

  

"name": "string",

  

  

  

"kind": "string",

  

  

  

"probability": 0,

  

  

  

"color": "string",

  

  

  

"position": 0

  

  

}

  

]

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/pipelines/{pipeline_id}

Playground

Headers

authorization

Variables

Key

Value

pipeline_id*

Body

Samples

---