> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heffl.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List deal pipelines

> Returns all active deal pipelines with stages. Use before creating deals — see Agent workflows guide.



## OpenAPI

````yaml /openapi.v2.json get /pipelines
openapi: 3.1.1
info:
  title: Heffl API v2 (Beta)
  version: 2.0.0
  description: >-
    Heffl REST API v2 (beta) — resource-oriented endpoints with consistent
    response envelopes. Endpoints, schemas, and behavior may change until GA.
    See Agent workflows and ID prefixes guides for automation.
  contact:
    name: Heffl Support
    url: https://heffl.com/support
    email: support@heffl.com
servers:
  - url: https://api.heffl.com/api/v2
    description: Production API Server
security:
  - ApiKeyAuth: []
paths:
  /pipelines:
    get:
      tags:
        - Reference Data
      summary: List deal pipelines
      description: >-
        Returns all active deal pipelines with stages. Use before creating deals
        — see Agent workflows guide.
      operationId: reference.pipelines.list
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Pipeline'
        '400':
          description: Validation error or bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '403':
          description: Insufficient permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
components:
  schemas:
    Pipeline:
      type: object
      required:
        - id
        - name
        - stages
      properties:
        id:
          type: string
          description: Pipeline ID (dpl_ prefix)
        name:
          type: string
          description: Pipeline name
        stages:
          type: array
          items:
            $ref: '#/components/schemas/PipelineStage'
    V2ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
    PipelineStage:
      type: object
      required:
        - id
        - name
        - position
        - probability
        - type
      properties:
        id:
          type: string
          description: Pipeline stage ID (dps_ prefix)
        name:
          type: string
          description: Stage name
        position:
          type: number
          description: Display order in the pipeline
        probability:
          type: number
          description: Win probability percentage
        type:
          type: string
          enum:
            - ACTIVE
            - WON
            - LOST
          description: >-
            Stage type. Moving a deal to a WON or LOST stage updates deal
            status.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Get yours at
        app.heffl.com/settings/developers

````