API Reference / Pipelines

GET /pipelines

Get all pipelines (associated with the logged API user's account)

Returns the account's deal pipelines, each with its ordered stages. default marks the pipeline that is default for you specifically, and stages carry a numeric position and a label.

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • pipelinesarray<object>
      array item fields →
      • pipelineobject

        Information about the sales process of products or services, including deal stages.

        object fields →
        • idstringbson-id

          ID of the pipeline

        • namestring

          Name of the pipeline

        • typestring

          Type of the pipeline (sales or delivery)

        • defaultboolean

          Is this pipeline the default pipeline in the account?

        • won_column_enabledboolean

          Specifies if the `WON` column is enabled for the pipeline

        • won_column_namestring

          Name of the `WON` column for the pipeline

        • stagesarray<object>

          Deal stages defined for the pipeline

          array item fields →
          • stageintegerint32

            Integer in the range 0 to 100 (exclusive) indicating how close a deal is to being closed

          • labelstring

            Text description for the deal stage of the deal

    • total_countintegerint32

      Total number of items

    • pageintegerint32

      Current page number

    • per_pageintegerint32

      Number of items returned in each page

    • max_pageintegerint32

      The page number of the last page of items

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides