go to pipedrive.com
Log inSign up

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

Returns data about all stages.

API v1
Request
GET

/v1/stages

Query parameters

pipeline_id

integer

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

start

integer

Pagination start

Default

0

limit

integer

Items shown per page

Response
200

OK

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

      Get one stage

      Copy link

      Returns data about a specific stage.

      API v1
      Request
      GET

      /v1/stages/{id}

      Path parameters

      id

      integer

      required

      The ID of the stage

      Query parameters

      everyone

      number

      If everyone=1 is provided, deals summary will return deals owned by every user

      Values

      0

      1

      Response
      200

      OK

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

        Get deals in a stage

        Copy link

        Lists deals in a specific stage.

        API v1
        Request
        GET

        /v1/stages/{id}/deals

        Path parameters

        id

        integer

        required

        The 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

        OK

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

            Add a new stage

            Copy link

            Adds a new stage, returns the ID upon success.

            API v1
            Request
            POST

            /v1/stages

            Body parameters

            application/json

            name

            string

            required

            The name of the stage

            pipeline_id

            integer

            required

            The ID of the pipeline to add stage to

            deal_probability

            integer

            The success probability percentage of the deal. Used/shown when deal weighted values are used.

            rotten_flag

            boolean

            Whether deals in this stage can become rotten

            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

            OK

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

              Update stage details

              Copy link

              Updates the properties of a stage.

              API v1
              Request
              PUT

              /v1/stages/{id}

              Path parameters

              id

              integer

              required

              The ID of the stage

              Body parameters

              application/json

              name

              string

              The name of the stage

              pipeline_id

              integer

              The ID of the pipeline to add stage to

              deal_probability

              integer

              The success probability percentage of the deal. Used/shown when deal weighted values are used.

              rotten_flag

              boolean

              Whether deals in this stage can become rotten

              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

              OK

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

                Delete multiple stages in bulk

                Copy link

                Marks multiple stages as deleted.

                API v1
                Request
                DELETE

                /v1/stages

                Query parameters

                ids

                string

                required

                The comma-separated stage IDs to delete

                Response
                200

                OK

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

                  Delete a stage

                  Copy link

                  Marks a stage as deleted.

                  API v1
                  Request
                  DELETE

                  /v1/stages/{id}

                  Path parameters

                  id

                  integer

                  required

                  The ID of the stage

                  Response
                  200

                  OK

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

                    Subscribe to Pipedrive’s Developer Newsletter