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

# List projects

> Returns the organisation's projects. Requires the `projects:read` scope.



## OpenAPI

````yaml /openapi.json get /projects
openapi: 3.1.0
info:
  title: Ledgitify REST API
  version: 1.0.0
  description: >-
    Programmatic access to a single organisation's Ledgitify projects, reports,
    allocations, and transactions. The API key alone determines which
    organisation is accessed; there is no tenant parameter on any endpoint.
    Every endpoint is read-only (GET) except `POST /transactions`, which pushes
    transactions in and requires the `transactions:write` scope.
  contact:
    name: Ledgitify
    url: https://ledgitify.com
servers:
  - url: https://ledgitify.com/api/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Projects
    description: Projects and their budget-vs-actual reports
  - name: Allocations
    description: Allocations recorded against a project's budget lines
  - name: Transactions
    description: Organisation-level accounting transactions
paths:
  /projects:
    get:
      tags:
        - Projects
      summary: List projects
      description: Returns the organisation's projects. Requires the `projects:read` scope.
      operationId: listProjects
      responses:
        '200':
          description: The organisation's projects.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Project'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Project:
      type: object
      required:
        - id
        - name
        - type
        - status
        - startDate
        - endDate
        - currency
        - budgetMode
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        type:
          type: string
          enum:
            - grant
            - commercial
            - internal
            - program
        status:
          type: string
          enum:
            - draft
            - locked
            - active
            - completed
            - archived
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        currency:
          type: string
          description: ISO 4217 code; defaults to AUD.
        budgetMode:
          type: string
        parentProjectId:
          type:
            - string
            - 'null'
          description: Set when this is a sub-project of a master.
        funder:
          type:
            - object
            - 'null'
          properties:
            name:
              type: string
            reference:
              type:
                - string
                - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - forbidden
                - insufficient_scope
                - not_found
                - rate_limited
            message:
              type: string
  responses:
    Unauthorized:
      description: Missing, malformed, unknown, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthorized
              message: Invalid or revoked API key.
    Forbidden:
      description: >-
        The plan does not include API access, or the key lacks the required
        scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            planGate:
              value:
                error:
                  code: forbidden
                  message: API access is not available on this plan.
            scope:
              value:
                error:
                  code: insufficient_scope
                  message: This key lacks the reports:read scope.
    RateLimited:
      description: Per-key rate limit exceeded (120 requests/minute).
      headers:
        Retry-After:
          description: Seconds until the limit resets.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: The per-minute request limit.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limited
              message: Rate limit exceeded.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: lk_live_...
      description: >-
        API key as a Bearer token: `Authorization: Bearer lk_live_<48 hex>`.
        Create keys in Settings → API keys (Owner or Admin); the full key is
        shown once. API access is a Professional+ feature. Each key is granted
        one or more scopes — read (`projects:read`, `reports:read`,
        `allocations:read`, `transactions:read`) and the single write scope
        (`transactions:write`) — and is limited to 120 requests per minute.

````