> ## Documentation Index
> Fetch the complete documentation index at: https://sure-917046f5-docs-cloudflare-tunnel-self-hosting.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List categories



## OpenAPI

````yaml /openapi.yaml get /api/v1/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/categories:
    get:
      tags:
        - Categories
      summary: List 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: classification
          in: query
          required: false
          description: Filter by classification (income or expense)
          schema:
            type: string
            enum:
              - income
              - expense
        - name: roots_only
          in: query
          required: false
          description: Return only root categories (no parent)
          schema:
            type: boolean
        - name: parent_id
          in: query
          required: false
          description: Filter by parent category ID
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: categories filtered by parent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryCollection'
      security:
        - apiKeyAuth: []
components:
  schemas:
    CategoryCollection:
      type: object
      required:
        - categories
        - pagination
      properties:
        categories:
          type: array
          items:
            $ref: '#/components/schemas/CategoryDetail'
        pagination:
          $ref: '#/components/schemas/Pagination'
    CategoryDetail:
      type: object
      required:
        - id
        - name
        - classification
        - color
        - icon
        - subcategories_count
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        classification:
          type: string
          enum:
            - income
            - expense
        color:
          type: string
        icon:
          type: string
        parent:
          $ref: '#/components/schemas/CategoryParent'
          nullable: true
        subcategories_count:
          type: integer
          minimum: 0
        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
    CategoryParent:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: API key for authentication. Generate one from your account settings.

````