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

# List all projects

> Retrieves a complete list of projects belonging to the authenticated workspace.



## OpenAPI

````yaml GET /projects
openapi: 3.1.0
info:
  title: Subly API
  description: >-
    The Subly API provides a comprehensive interface to manage your workspace's
    financial data, including expenses, revenue, transactions, and projects.
  version: 1.0.0
  license:
    name: MIT
servers:
  - url: https://web.subly.app/api/v1
    description: Production API Server
security:
  - apiKeyAuth: []
tags:
  - name: Projects
    description: Manage projects to organize your financial items.
  - name: Expenses
    description: >-
      Operations related to workspace expenses, such as subscriptions or
      one-time costs.
  - name: Revenue
    description: Operations related to workspace revenue items.
  - name: Transactions
    description: Operations related to individual financial transactions.
paths:
  /projects:
    get:
      tags:
        - Projects
      summary: List all projects
      description: >-
        Retrieves a complete list of projects belonging to the authenticated
        workspace.
      responses:
        '200':
          description: A list of projects.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
components:
  schemas:
    Project:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the project.
          readOnly: true
        name:
          type: string
          description: The name of the project.
        workspace_id:
          type: string
          format: uuid
          description: Identifier of the workspace this project belongs to.
          readOnly: true
        budget_amount:
          type: number
          format: float
          description: The financial budget allocated to the project.
        budget_period:
          type: string
          enum:
            - month
            - year
          description: The time period the budget covers.
        budget_currency:
          type: string
          description: >-
            The ISO 4217 currency code for the budget amount (e.g., 'USD',
            'AUD').
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: A message describing the error.
  responses:
    UnauthorizedError:
      description: Authentication error. The API key is missing, invalid, or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your private API key for authentication. This key identifies your
        workspace for all requests.

````