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

# List budget categories



## OpenAPI

````yaml /openapi.yaml get /api/v1/budget_categories
openapi: 3.0.3
info:
  title: Sure API
  version: v1
  description: OpenAPI documentation for the Sure API.
servers:
  - url: https://app.sure.am
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
paths:
  /api/v1/budget_categories:
    get:
      tags:
        - Budget Categories
      summary: List budget categories
      parameters:
        - name: page
          in: query
          required: false
          description: 'Page number (default: 1)'
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: 'Items per page (default: 25, max: 100)'
          schema:
            type: integer
        - name: budget_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Filter by budget ID
        - name: category_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Filter by category ID
        - name: start_date
          in: query
          required: false
          schema:
            type: string
            format: date
          description: Filter budget categories whose budget starts on or after this date
        - name: end_date
          in: query
          required: false
          schema:
            type: string
            format: date
          description: Filter budget categories whose budget ends on or before this date
      responses:
        '200':
          description: budget categories listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetCategoryCollection'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: invalid filter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    BudgetCategoryCollection:
      type: object
      required:
        - budget_categories
        - pagination
      properties:
        budget_categories:
          type: array
          items:
            $ref: '#/components/schemas/BudgetCategorySummary'
        pagination:
          $ref: '#/components/schemas/Pagination'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        message:
          type: string
          nullable: true
        details:
          oneOf:
            - type: array
              items:
                type: string
            - type: object
          nullable: true
    BudgetCategorySummary:
      type: object
      required:
        - id
        - budget_id
        - currency
        - subcategory
        - inherits_parent_budget
        - category
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        budget_id:
          type: string
          format: uuid
        currency:
          type: string
        subcategory:
          type: boolean
        inherits_parent_budget:
          type: boolean
        budgeted_spending:
          type: string
        budgeted_spending_cents:
          type: integer
        display_budgeted_spending:
          type: string
        display_budgeted_spending_cents:
          type: integer
        category:
          type: object
          required:
            - id
            - name
            - color
            - lucide_icon
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
            color:
              type: string
            lucide_icon:
              type: string
            parent_id:
              type: string
              format: uuid
              nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Pagination:
      type: object
      required:
        - page
        - per_page
        - total_count
        - total_pages
      properties:
        page:
          type: integer
          minimum: 1
        per_page:
          type: integer
          minimum: 1
        total_count:
          type: integer
          minimum: 0
        total_pages:
          type: integer
          minimum: 0
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: API key for authentication. Generate one from your account settings.

````