provider Pipelines GET /pipelines/{id}/deals
@utdk/pipedrive /pipelines/{id}/deals
Get deals in a pipeline
Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned. <br>This endpoint has been deprecated. Please use <a href="https://developers.pipedrive.com/docs/api/v1/Deals#getDeals" target="_blank" rel="noopener noreferrer">GET /api/v2/deals?pipeline_id={id}</a> instead.
id path required
The ID of the pipeline
integer
filter_id query
If supplied, only deals matching the given filter will be returned
integer
user_id query
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.
integer
everyone query
If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
enum: 0, 1
stage_id query
If supplied, only deals within the given stage will be returned
integer
start query
Pagination start
integer
limit query
Items shown per page
integer
get_summary query
Whether to include a summary of the pipeline in the `additional_data` or not
enum: 0, 1
totals_convert_currency query
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.
string

Try it

Authentication
Configure credentials for Pipedrive API v1
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getpipelinedeals
GET/pipelines/{id}/deals
Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned. <br>This endpoint has been deprecated. Please use <a href="https://developers.pipedrive.com/docs/api/v1/Deals#getDeals" target="_blank" rel="noopener noreferrer">GET /api/v2/deals?pipeline_id={id}</a> instead.

Parameters

required

The ID of the pipeline

If supplied, only deals matching the given filter will be returned

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.

If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned

If supplied, only deals within the given stage will be returned

Pagination start

Items shown per page

Whether to include a summary of the pipeline in the `additional_data` or not

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.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import pipedrive from '@utdk/pipedrive';

await pipedrive.getpipelinedeals({
  "start": 0
})