Pipedrive API

Getting access, Developing, Testing

Back to Pipedrive

Get one pipeline

Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.

Input

type: object properties: parameters: type: object properties: id: type: integer description: The ID of the pipeline totals_convert_currency: type: string description: >- The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` 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. required: - id

Output

type: object title: getPipelineResponse200 properties: success: type: boolean description: If the response is successful or not data: type: object description: The pipeline object title: pipelineDetails properties: id: type: integer description: The ID of the pipeline name: type: string description: The name of the pipeline url_title: type: string description: The pipeline title displayed in the URL order_nr: type: integer description: >- Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline. active: type: boolean description: Whether this pipeline will be made inactive (hidden) or active deal_probability: type: boolean description: Whether deal probability is disabled or enabled for this pipeline add_time: type: string description: 'The pipeline creation time. Format: YYYY-MM-DD HH:MM:SS.' update_time: type: string description: 'The pipeline update time. Format: YYYY-MM-DD HH:MM:SS.' selected: type: boolean description: A boolean that shows if the pipeline is selected from a filter or not deals_summary: type: object description: Deals summary properties: per_stages: type: object description: The stage objects containing deals currency information properties: STAGE_ID: type: object description: >- The currency summaries per stage. This parameter is dynamic and changes according to `stage_id` value. properties: CURRENCY_ID: type: object description: >- The currency summary. This parameter is dynamic and changes according to `currency_id` value. properties: count: type: integer description: Deals count per currency value: type: integer description: Deals value per currency value_formatted: type: string description: Deals value formatted per currency weighted_value: type: integer description: Deals weighted value per currency weighted_value_formatted: type: string description: Deals weighted value formatted per currency per_currency: type: object description: The currency count summary properties: CURRENCY_ID: type: integer description: >- Deals count per currency. This parameter is dynamic and changes according to `currency_id` value. total_count: type: integer description: Deals count per_currency_full: type: object description: Full currency summaries properties: CURRENCY_ID: type: object description: >- The currency summary. This parameter is dynamic and changes according to `currency_id` value. properties: count: type: integer description: Deals count per currency value: type: integer description: Deals value per currency