Stages

Stage is a logical component of a Pipeline, and essentially a bucket that can hold a number of Deals. In the context of the Pipeline a stage belongs to, it has an order number which defines the order of stages in that Pipeline.

Get all stages

Copy link
Copy to clipboard
GET

/v1/stages

Returns data about all stages.

Query parameters

pipeline_id

integer

The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched.

Response
200

Get all Stages

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

    Get one stage

    Copy link
    Copy to clipboard
    GET

    /v1/stages/{id}

    Returns data about a specific stage.

    Path parameters

    id

    integer

    required

    ID of the stage

    Response
    200

    Get Stage

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

      Get deals in a stage

      Copy link
      Copy to clipboard
      GET

      /v1/stages/{id}/deals

      Lists deals in a specific stage.

      Path parameters

      id

      integer

      required

      ID of the stage

      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

      start

      integer

      Pagination start

      Default

      0

      limit

      integer

      Items shown per page

      Response
      200

      Get Deals in a Stage

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

          Add a new stage

          Copy link
          Copy to clipboard
          POST

          /v1/stages

          Adds a new stage, returns the ID upon success.

          Body parameters

          application/x-www-form-urlencoded

          name

          string

          required

          Name of the Stage

          pipeline_id

          integer

          required

          The ID of the Pipeline to add Stage to.

          deal_probability

          integer

          Deal success probability percentage. Used/shown when Deal weighted values are used

          rotten_flag

          integer

          Whether Deals in this stage can become rotten

          Values

          0

          1

          rotten_days

          integer

          The number of days the Deals not updated in this Stage would become rotten. Applies only if the rotten_flag is set.

          Response
          200

          Get all Stages

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

            Update stage details

            Copy link
            Copy to clipboard
            PUT

            /v1/stages/{id}

            Updates the properties of a stage.

            Path parameters

            id

            integer

            required

            ID of the stage

            Body parameters

            application/x-www-form-urlencoded

            name

            string

            Name of the Stage

            pipeline_id

            integer

            The ID of the Pipeline to add Stage to.

            deal_probability

            integer

            Deal success probability percentage. Used/shown when Deal weighted values are used

            rotten_flag

            integer

            Whether Deals in this stage can become rotten

            Values

            0

            1

            rotten_days

            integer

            The number of days the Deals not updated in this Stage would become rotten. Applies only if the rotten_flag is set.

            order_nr

            integer

            An order number for this stage. Order numbers should be used to order the stages in the pipeline.

            Response
            200

            Get all Stages

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

              Delete multiple stages in bulk

              Copy link
              Copy to clipboard
              DELETE

              /v1/stages

              Marks multiple stages as deleted.

              Query parameters

              ids

              string

              required

              Comma-separated stage IDs to delete

              Response
              200

              Delete multiple Stages

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

                Delete a stage

                Copy link
                Copy to clipboard
                DELETE

                /v1/stages/{id}

                Marks a stage as deleted.

                Path parameters

                id

                integer

                required

                ID of the stage

                Response
                200

                Delete Stage

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

                  Subscribe to Pipedrive’s Developer Newsletter