> ## 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 projects

> Returns a paginated list of projects. Supports cursor pagination, full-text search (title, number, description), and filtering by status, type, pipeline, stage, client, or project lead.



## OpenAPI

````yaml /openapi.v2.json get /projects
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:
  /projects:
    get:
      tags:
        - Objects
      summary: List projects
      description: >-
        Returns a paginated list of projects. Supports cursor pagination,
        full-text search (title, number, description), and filtering by status,
        type, pipeline, stage, client, or project lead.
      operationId: objects.projects.list
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Cursor for pagination. Pass the previous response meta.nextCursor
            value to fetch the next page.
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 30
          description: Number of items to return per page (max 100)
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: Search by project title, number, or description
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - ACTIVE
              - COMPLETED
              - CANCELLED
          description: Filter by project status
        - name: type
          in: query
          required: false
          schema:
            type: string
            enum:
              - flat_rate
              - retainer
          description: Filter by project type
        - name: pipelineId
          in: query
          required: false
          schema:
            type: string
          description: Filter by project pipeline ID (ppl_ prefix)
        - name: stageId
          in: query
          required: false
          schema:
            type: string
          description: Filter by project pipeline stage ID (pps_ prefix)
        - name: clientId
          in: query
          required: false
          schema:
            type: string
          description: Filter by client ID (clt_ prefix)
        - name: projectLeadId
          in: query
          required: false
          schema:
            type: string
          description: Filter by project lead user ID (usr_ prefix)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Project'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '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:
    Project:
      type: object
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          description: Project ID (prj_ prefix)
        number:
          type: string
          description: Auto-generated project number
        title:
          type: string
          description: Project title
        status:
          anyOf:
            - type: string
              enum:
                - ACTIVE
                - COMPLETED
                - CANCELLED
            - type: 'null'
          description: Project status
        type:
          anyOf:
            - type: string
              enum:
                - flat_rate
                - retainer
            - type: 'null'
          description: Project type
        startDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: Project start date
        endDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: Project end date
        pipelineId:
          anyOf:
            - type: string
            - type: 'null'
          description: Project pipeline ID (ppl_ prefix)
        pipelineName:
          anyOf:
            - type: string
            - type: 'null'
          description: Pipeline name
        stageId:
          anyOf:
            - type: string
            - type: 'null'
          description: Project pipeline stage ID (pps_ prefix)
        stageName:
          anyOf:
            - type: string
            - type: 'null'
          description: Stage name
        projectLeadId:
          anyOf:
            - type: string
            - type: 'null'
          description: Project lead user ID (usr_ prefix)
        projectLeadName:
          anyOf:
            - type: string
            - type: 'null'
          description: Project lead name
        clientId:
          anyOf:
            - type: string
            - type: 'null'
          description: Client ID (clt_ prefix)
        clientName:
          anyOf:
            - type: string
            - type: 'null'
          description: Client name
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: Project description
        budgetedHours:
          anyOf:
            - type: number
            - type: 'null'
          description: Budgeted hours
        createdAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When the project was created
        updatedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When the project was last updated
      required:
        - id
        - number
        - title
      additionalProperties:
        description: >-
          Custom field values as top-level cf_* keys (for example cf_priority).
          There is no customFields wrapper.
    ListMeta:
      type: object
      properties:
        nextCursor:
          type:
            - string
            - 'null'
          description: Cursor to fetch the next page. Null if there are no more results.
        hasMore:
          type: boolean
          description: Whether additional results are available
      required:
        - hasMore
    V2ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Get yours at
        app.heffl.com/settings/developers

````