> ## 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.

# List Folder Contents

> Returns what's inside one folder: the folder node itself, its direct
subfolders (`folders`, name-ordered, not paginated), and the files
placed in it (`files`, newest first, paginated with `page`/`pageSize`;
`totalCount` counts the files). Only finalized (`ready`) files appear.

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




## OpenAPI

````yaml /openapi/generated-external-api.yaml get /api/v1/companies/{companyId}/folders/{folderId}
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/{folderId}:
    get:
      tags:
        - Company Files
      summary: List Folder Contents
      description: |
        Returns what's inside one folder: the folder node itself, its direct
        subfolders (`folders`, name-ordered, not paginated), and the files
        placed in it (`files`, newest first, paginated with `page`/`pageSize`;
        `totalCount` counts the files). Only finalized (`ready`) files appear.

        **Required permission:** `company.file:read`
      operationId: listFolderContents
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/folderId'
        - $ref: '#/components/parameters/page'
        - name: pageSize
          in: query
          schema:
            type: integer
            minimum: 1
            default: 50
          description: Number of records per page (default 50).
      responses:
        '200':
          description: The folder's contents
          content:
            application/json:
              schema:
                type: object
                properties:
                  folder:
                    $ref: '#/components/schemas/Folder'
                  folders:
                    type: array
                    description: The folder's direct subfolders
                    items:
                      $ref: '#/components/schemas/Folder'
                  files:
                    type: array
                    description: The files placed directly in the folder (paginated)
                    items:
                      $ref: '#/components/schemas/CompanyFileListItem'
                  totalCount:
                    type: integer
                    description: Total number of files in the folder across all pages
              examples:
                success:
                  summary: Folder with a subfolder and a file
                  value:
                    folder:
                      id: 550e8400-e29b-41d4-a716-446655440001
                      parentFolderId: null
                      name: Claims Documents
                    folders:
                      - id: 550e8400-e29b-41d4-a716-446655440002
                        parentFolderId: 550e8400-e29b-41d4-a716-446655440001
                        name: 2026 Q1
                    files:
                      - id: 550e8400-e29b-41d4-a716-446655440020
                        entityType: company
                        entityId: null
                        displayName: claim-report.pdf
                        contentType: application/pdf
                        byteSize: 102400
                        uploadedAt: '2026-06-10T09:15:00.000Z'
                        uploadedBy: 550e8400-e29b-41d4-a716-446655440099
                        uploadedByName: Jane Underwriter
                        folderId: 550e8400-e29b-41d4-a716-446655440001
                        category: null
                    totalCount: 1
                emptyFolder:
                  summary: Empty folder
                  value:
                    folder:
                      id: 550e8400-e29b-41d4-a716-446655440001
                      parentFolderId: null
                      name: Claims Documents
                    folders: []
                    files: []
                    totalCount: 0
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Folder not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                notFound:
                  summary: Folder does not exist
                  value:
                    error:
                      code: NotFound
                      message: 'Folder not found: 550e8400-e29b-41d4-a716-446655440001'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
    folderId:
      name: folderId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Folder identifier
    page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number (1-based, default 1).
  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
    CompanyFileListItem:
      type: object
      description: >
        One file in an owner listing — the file's display identity joined to its

        current version. Pending (never finalized) uploads are never listed;

        versions held by the malware-scanning gate ARE listed with their
        `status`

        (`quarantined` while the scan verdict is outstanding, `infected` once

        condemned — neither is downloadable).
      properties:
        id:
          type: string
          format: uuid
          description: File identifier
        entityType:
          type: string
          enum:
            - event
            - exposure
            - quote
            - submission
            - person
            - organization
            - policy
            - company
          description: The file owner's entity type
        entityId:
          type: string
          format: uuid
          nullable: true
          description: The owner entity's id (null for company-level files)
        placementId:
          type: string
          format: uuid
          description: |
            The placement this list row is — the file's appearance under the
            listed owner. Per-placement operations (e.g. Remove File Placement)
            address it by this id.
        placementCount:
          type: integer
          description: >
            Number of live placements of the file across all owners. Greater
            than

            1 means the file is shared to other entities as well.
        displayName:
          type: string
          description: The file's display name (renameable)
        contentType:
          type: string
          description: MIME type of the current version
        byteSize:
          type: integer
          description: Size of the current version in bytes
        status:
          type: string
          enum:
            - ready
            - quarantined
            - infected
          description: |
            The current version's lifecycle state. `ready` = downloadable;
            `quarantined` = malware scan verdict outstanding (not yet
            downloadable); `infected` = malware detected (downloads permanently
            refused). Never `pending` — in-flight uploads are excluded from
            listings.
        displayDate:
          type: string
          format: date-time
          nullable: true
          description: >-
            Optional back-datable "as of" date. When set, listings display and
            sort the file by this date instead of `uploadedAt` — intended for
            historical imports and integrations.
        displayAuthor:
          type: string
          nullable: true
          description: >-
            Optional user-visible uploader label. When set, the file is
            presented as uploaded by this label instead of `uploadedByName` —
            intended for historical imports carrying the source system's author
            (or a marker like "Data Import"). Uploader attribution stays
            server-set.
        uploadedAt:
          type: string
          format: date-time
          description: When the current version was uploaded (ISO 8601)
        uploadedBy:
          type: string
          nullable: true
          description: Id of the user / API key creator who uploaded the current version
        uploadedByName:
          type: string
          nullable: true
          description: Display name of the uploader (resolved for display)
        folderId:
          type: string
          format: uuid
          nullable: true
          description: The folder the file is placed in (null = the owner's top level)
        category:
          type: string
          nullable: true
          description: Optional category label
    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.

````