Pipelines

For more details about pipelines and how to use them with deal statuses, please refer to the help article.

Pipelines serve as a tool for grouping deal statuses (i.e. folders for better organisation of sales phases).

Following depicts the Pipeline entity relationship diagram:

Deal Status 1Deal Status 2Deal Status 3Deal Status 4Sales PipelineAnother Pipeline

Attributes

created_at string
Response

Timestamp when the pipeline was created.
creator person
Response

Person who created this pipeline.
icon_id string
Response Request

Icon ID used to visually identify this pipeline.
name string
Response Request

Display name of the pipeline.
organization organization
Response

The organization this pipeline belongs to.
pipeline_type_id integer
Response Request Parameter `filter` Enum

Pipeline type: 1 = sales (opportunities), 2 = production (budgets).

Enum Values (2 values)

  • 1
  • 2
position integer
Response Request

Display order of this pipeline relative to other pipelines.
updated_at string
Response

Timestamp of the last modification to this pipeline.
updater person
Response

Person who last updated this pipeline.

Operations

GET /api/v2/pipelines
Get pipelines
POST /api/v2/pipelines
Create a pipeline
DELETE /api/v2/pipelines/{id}
Deletes a pipeline
GET /api/v2/pipelines/{id}
Gets a pipeline
PATCH /api/v2/pipelines/{id}
Update a pipeline