Pipelines

Pipelines are essentially ordered collections of Stages.

Get all pipelines

Copy link
Copy to clipboard
GET

/v1/pipelines

Returns data about all pipelines

Response
200

Get all Pipelines

Expand all
Copy code
    • true
    • [ ... ]

    Get one pipeline

    Copy link
    Copy to clipboard
    GET

    /v1/pipelines/{id}

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

    Path parameters

    id

    integer

    required

    ID of the pipeline

    Query parameters

    totals_convert_currency

    string

    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.

    Response
    200

    Get Pipeline

    Expand all
    Copy code
      • true
      • { ... }

      Get deals conversion rates in pipeline

      Copy link
      Copy to clipboard
      GET

      /v1/pipelines/{id}/conversion_statistics

      Returns all stage-to-stage conversion and pipeline-to-close rates for given time period.

      Path parameters

      id

      integer

      required

      ID of the pipeline

      Query parameters

      start_date

      string

      required

      Start of the period. Date in format of YYYY-MM-DD.

      Format

      date

      end_date

      string

      required

      End of the period. Date in format of YYYY-MM-DD.

      Format

      date

      user_id

      integer

      ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.

      Response
      200

      Get Pipeline Deals conversion rates

      Expand all
      Copy code
        • true
        • { ... }

        Get deals in a pipeline

        Copy link
        Copy to clipboard
        GET

        /v1/pipelines/{id}/deals

        Lists deals in a specific pipeline across all its stages

        Path parameters

        id

        integer

        required

        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 summary of the pipeline in the additional_data or not.

        Values

        0

        1

        totals_convert_currency

        string

        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
        200

        Get Deals in a Stage

        Expand all
        Copy code
          • true
          • [ ... ]
            • { ... }

            Get deals movements in pipeline

            Copy link
            Copy to clipboard
            GET

            /v1/pipelines/{id}/movement_statistics

            Returns statistics for deals movements for given time period.

            Path parameters

            id

            integer

            required

            ID of the pipeline

            Query parameters

            start_date

            string

            required

            Start of the period. Date in format of YYYY-MM-DD.

            Format

            date

            end_date

            string

            required

            End of the period. Date in format of YYYY-MM-DD.

            Format

            date

            user_id

            integer

            ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.

            Response
            200

            Get Pipeline Deals conversion rates

            Expand all
            Copy code
              • true
              • { ... }

              Add a new pipeline

              Copy link
              Copy to clipboard
              POST

              /v1/pipelines

              Adds a new pipeline

              Body parameters

              application/x-www-form-urlencoded

              name

              string

              required

              The name of the Pipeline

              deal_probability

              Whether Deal probability is disabled or enabled for this Pipeline

              Values

              0

              1

              order_nr

              integer

              Defines the order of Pipelines. First order (order_nr=0) is the default Pipeline.

              active

              Whether this Pipeline will be made inactive (hidden) or active

              Values

              0

              1

              Response
              200

              Add Pipeline

              Expand all
              Copy code
                • true
                • { ... }

                Edit a pipeline

                Copy link
                Copy to clipboard
                PUT

                /v1/pipelines/{id}

                Updates pipeline properties

                Path parameters

                id

                integer

                required

                ID of the pipeline

                Body parameters

                application/x-www-form-urlencoded

                name

                string

                The name of the Pipeline

                deal_probability

                Whether Deal probability is disabled or enabled for this Pipeline

                Values

                0

                1

                order_nr

                integer

                Defines the order of Pipelines. First order (order_nr=0) is the default Pipeline.

                active

                Whether this Pipeline will be made inactive (hidden) or active

                Values

                0

                1

                Response
                200

                Edit Pipeline

                Expand all
                Copy code
                  • true
                  • { ... }

                  Delete a pipeline

                  Copy link
                  Copy to clipboard
                  DELETE

                  /v1/pipelines/{id}

                  Marks a pipeline as deleted.

                  Path parameters

                  id

                  integer

                  required

                  ID of the pipeline

                  Response
                  200

                  Delete Pipeline

                  Expand all
                  Copy code
                    • true
                    • { ... }

                    Subscribe to Pipedrive’s Developer Newsletter