> ## 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 project pipelines

> Returns all active project pipelines with their stages. Use before creating or filtering projects — you need a pipeline ID (ppl_) and usually a stage ID (pps_) from the nested stages array.



## OpenAPI

````yaml /openapi.v2.json get /project-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:
  /project-pipelines:
    get:
      tags:
        - Reference Data
      summary: List project pipelines
      description: >-
        Returns all active project pipelines with their stages. Use before
        creating or filtering projects — you need a pipeline ID (ppl_) and
        usually a stage ID (pps_) from the nested stages array.
      operationId: reference.projectPipelines.list
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProjectPipeline'
        '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:
    ProjectPipeline:
      type: object
      required:
        - id
        - name
        - stages
      properties:
        id:
          type: string
          description: Project pipeline ID (ppl_ prefix)
        name:
          type: string
          description: Pipeline name
        stages:
          type: array
          items:
            $ref: '#/components/schemas/ProjectPipelineStage'
    V2ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
    ProjectPipelineStage:
      type: object
      required:
        - id
        - name
        - position
        - type
      properties:
        id:
          type: string
          description: Project pipeline stage ID (pps_ prefix)
        name:
          type: string
          description: Stage name
        position:
          type: number
          description: Display order in the pipeline
        type:
          type: string
          enum:
            - OPEN
            - CLOSED
          description: >-
            Stage type. Moving a project to a CLOSED (WON) stage completes the
            project.
        closedType:
          anyOf:
            - type: string
              enum:
                - WON
                - LOST
            - type: 'null'
          description: For CLOSED stages, whether the stage represents WON or LOST.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Get yours at
        app.heffl.com/settings/developers

````