Pipelines
Pipelines are essentially ordered collections of stages.
Get all pipelines
Returns data about all pipelines.
Request
/api/v2/pipelines
Query parameters
sort_by
string
The field to sort by. Supported fields: id, update_time, add_time
Default
id
Values
id
update_time
add_time
sort_direction
string
The sorting direction. Supported values: asc, desc
Default
asc
Values
asc
desc
limit
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
cursor
string
For pagination, the marker (an opaque string value) representing the first item on the next page
Response
OK
Expand all
Copy code- true
- [ ... ]▶
- { ... }▶
Get one pipeline
Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
Request
/api/v2/pipelines/{id}
Path parameters
id
integer
required
The ID of the pipeline
Response
OK
Expand allCopy code- true
- { ... }▶
Get deals conversion rates in pipeline
Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
Request
/v1/pipelines/{id}/conversion_statistics
Path parameters
id
integer
required
The ID of the pipeline
Query parameters
start_date
string
required
The start of the period. Date in format of YYYY-MM-DD.
Format
date
end_date
string
required
The end of the period. Date in format of YYYY-MM-DD.
Format
date
user_id
integer
The ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
Response
OK
Expand allCopy code- true
- { ... }▶
Get deals in a pipeline
Lists deals in a specific pipeline across all its stages.
Request
/v1/pipelines/{id}/deals
Path parameters
id
integer
required
The ID of the pipeline
Query parameters
filter_id
integer
If supplied, only deals matching the given filter will be returned
user_id
integer
If supplied, filter_id will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
everyone
number
If supplied, filter_id and user_id will not be considered – instead, deals owned by everyone will be returned
Values
0
1
stage_id
integer
If supplied, only deals within the given stage will be returned
start
integer
Pagination start
Default
0
limit
integer
Items shown per page
get_summary
number
Whether to include a summary of the pipeline in the additional_data or not
Values
0
1
totals_convert_currency
string
The 3-letter currency code of any of the supported currencies. When supplied, per_stages_converted is returned inside deals_summary inside additional_data which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to default_currency in which case users default currency is used. Only works when get_summary parameter flag is enabled.
Response
OK
Expand allCopy code- true
- [ ... ]▶
- { ... }▶
Get deals movements in pipeline
Returns statistics for deals movements for the given time period.
Request
/v1/pipelines/{id}/movement_statistics
Path parameters
id
integer
required
The ID of the pipeline
Query parameters
start_date
string
required
The start of the period. Date in format of YYYY-MM-DD.
Format
date
end_date
string
required
The end of the period. Date in format of YYYY-MM-DD.
Format
date
user_id
integer
The ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.
Response
OK
Expand allCopy code- true
- { ... }▶
Add a new pipeline
Adds a new pipeline.
Request
/api/v2/pipelines
Body parameters
application/json
name
string
required
The name of the pipeline
is_deal_probability_enabled
boolean
Whether deal probability is disabled or enabled for this pipeline
Response
OK
Expand allCopy code- true
- { ... }▶
Update a pipeline
Updates the properties of a pipeline.
Request
/api/v2/pipelines/{id}
Path parameters
id
integer
required
The ID of the pipeline
Body parameters
application/json
name
string
The name of the pipeline
is_deal_probability_enabled
boolean
Whether deal probability is disabled or enabled for this pipeline
Response
OK
Expand allCopy code- true
- { ... }▶
Delete a pipeline
Marks a pipeline as deleted.
Request
/api/v2/pipelines/{id}
Path parameters
id
integer
required
The ID of the pipeline
Response
OK
Expand allCopy code- true
- { ... }▶