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

# Get Folder Tree

> Returns an owner's whole live folder tree as flat adjacency-list rows —
each folder carries its `parentFolderId` (null = top level) and
consumers assemble the hierarchy client-side. Not paginated; the
response is the complete tree for the owner.

**Required permission:** `company.file:read`




## OpenAPI

````yaml /openapi/generated-external-api.yaml get /api/v1/companies/{companyId}/folders
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://go.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/companies/{companyId}/folders:
    get:
      tags:
        - Company Files
      summary: Get Folder Tree
      description: |
        Returns an owner's whole live folder tree as flat adjacency-list rows —
        each folder carries its `parentFolderId` (null = top level) and
        consumers assemble the hierarchy client-side. Not paginated; the
        response is the complete tree for the owner.

        **Required permission:** `company.file:read`
      operationId: getFolderTree
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/fileOwnerEntityType'
        - $ref: '#/components/parameters/fileOwnerEntityId'
      responses:
        '200':
          description: The owner's folder tree
          content:
            application/json:
              schema:
                type: object
                properties:
                  folders:
                    type: array
                    items:
                      $ref: '#/components/schemas/Folder'
              examples:
                success:
                  summary: Folder tree
                  value:
                    folders:
                      - id: 550e8400-e29b-41d4-a716-446655440001
                        parentFolderId: null
                        name: Claims Documents
                      - id: 550e8400-e29b-41d4-a716-446655440002
                        parentFolderId: 550e8400-e29b-41d4-a716-446655440001
                        name: 2026 Q1
                emptyTree:
                  summary: No folders for the owner
                  value:
                    folders: []
        '400':
          description: Bad Request — invalid owner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidEntityType:
                  summary: Unknown entity type
                  value:
                    error:
                      code: BadRequest
                      message: >-
                        Invalid entity type. Must be a configured entity or
                        'company'.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
    fileOwnerEntityType:
      name: entityType
      in: query
      required: true
      schema:
        type: string
        enum:
          - event
          - exposure
          - quote
          - submission
          - person
          - organization
          - policy
          - company
      description: |
        The file owner's entity type — a configured Field Model V1 entity type
        (lowercase kebab-case URL slug, e.g. `event`, `exposure`, `policy`), or
        `company` for company-level files and folders. PascalCase (`Event`) is
        rejected with a 400 — matching the `/entities/{type}` path convention.
    fileOwnerEntityId:
      name: entityId
      in: query
      required: false
      schema:
        type: string
        format: uuid
      description: >
        The owner entity's id. Required for every `entityType` except `company`

        (company-level files and folders have no entity id — omit this
        parameter).
  schemas:
    Folder:
      type: object
      description: >
        One folder node as a flat adjacency-list row — `parentFolderId` null
        means

        the owner's top level. The folder tree endpoint returns every live
        folder

        for an owner as these rows; consumers assemble the hierarchy
        client-side.
      properties:
        id:
          type: string
          format: uuid
          description: Folder identifier
        parentFolderId:
          type: string
          format: uuid
          nullable: true
          description: Parent folder id, or null for top-level folders
        name:
          type: string
          description: Folder name
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            userMessages:
              type: array
              description: >-
                Clean, verbatim-displayable messages — one entry per failure,
                free of error-code tags, field paths, and internal noise.
                Suitable for showing to end users as-is.
              items:
                type: string
              example:
                - Exposures of type 'company' require an address
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: AuthenticationError
                  message: API key authentication required
                  userMessages:
                    - API key authentication required
            invalidApiKey:
              summary: >-
                Invalid API key (e.g. unknown key, or a Bearer token used
                instead of an API key)
              value:
                error:
                  code: AuthenticationError
                  message: Invalid API key
                  userMessages:
                    - Invalid API key
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: AuthorizationError
                  message: User is not authorized to perform the requested action
                  userMessages:
                    - User is not authorized to perform the requested action
            companyMismatch:
              summary: A valid API key naming another company in the URL
              value:
                error:
                  code: AuthorizationError
                  message: API key is not scoped to the requested company
                  userMessages:
                    - API key is not scoped to the requested company
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: UncaughtActionError
                  message: Uncaught error occurred in <actionName>
                  userMessages:
                    - An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Send your raw API key as the `Authorization`
        header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do
        NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key`
        header; those are not accepted.

````