v1

latestOpenAPI 3.0.12026-08-0621301.7 MB
Pipelines

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.

get/pipelines/{id}/deals

Path parameters

idinteger required

The ID of the pipeline

Query parameters

filter_idinteger

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

user_idinteger

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.

everyone0 | 1

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

stage_idinteger

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

startinteger

Pagination start

limitinteger

Items shown per page

get_summary0 | 1

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

totals_convert_currencystring

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

Get deals in a stage

successboolean

If the request was successful or not