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

> Lists a company's form library — one summary per form (its current
version), covering both DOCX templates and static PDF forms. Paginated.

Each item carries the form's `number` (the `FM-XXXX` handle you pass to the
download, replace, and delete endpoints), `name`, `kind` (`template` vs
`static`), `category`, `templateKey`, `version`, and timestamps.

Narrow the result with the optional `category` and/or `kind` query
parameters. `totalCount` is the number of forms matching the filters across
all pages.

**Required permission:** `forms:read`




## OpenAPI

````yaml /openapi/generated-external-api.yaml get /api/v1/companies/{companyId}/forms
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}/forms:
    get:
      tags:
        - Forms
      summary: List Forms
      description: >
        Lists a company's form library — one summary per form (its current

        version), covering both DOCX templates and static PDF forms. Paginated.


        Each item carries the form's `number` (the `FM-XXXX` handle you pass to
        the

        download, replace, and delete endpoints), `name`, `kind` (`template` vs

        `static`), `category`, `templateKey`, `version`, and timestamps.


        Narrow the result with the optional `category` and/or `kind` query

        parameters. `totalCount` is the number of forms matching the filters
        across

        all pages.


        **Required permission:** `forms:read`
      operationId: listForms
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize50'
        - name: category
          in: query
          required: false
          schema:
            type: string
            enum:
              - event
              - quote-flow
              - quote-bind-flow
              - unknown
          description: When set, return only forms assigned to this category.
        - name: kind
          in: query
          required: false
          schema:
            type: string
            enum:
              - template
              - static
          description: >-
            When set, return only forms of this kind — `template` (DOCX) or
            `static` (PDF).
      responses:
        '200':
          description: The company's forms
          content:
            application/json:
              schema:
                type: object
                required:
                  - forms
                  - totalCount
                properties:
                  forms:
                    type: array
                    items:
                      $ref: '#/components/schemas/Fmv1FormSummary'
                  totalCount:
                    type: integer
                    description: Total forms matching the filters, across all pages.
              examples:
                success:
                  summary: A company's forms
                  value:
                    totalCount: 2
                    forms:
                      - templateKey: 550e8400-e29b-41d4-a716-446655440040
                        checkpointId: 550e8400-e29b-41d4-a716-446655440041
                        companyId: 550e8400-e29b-41d4-a716-446655440000
                        name: Certificate of Insurance
                        number: FM-0010
                        category: quote-bind-flow
                        storagePath: >-
                          acme/550e8400-.../formTemplates/550e8400-.../V-001/550e8400-....docx
                        version: 1
                        kind: template
                        createdAt: '2026-07-01T09:15:00.000Z'
                        createdBy: 550e8400-e29b-41d4-a716-446655440099
                        updatedAt: '2026-07-01T09:15:00.000Z'
                        updatedBy: 550e8400-e29b-41d4-a716-446655440099
                      - templateKey: 550e8400-e29b-41d4-a716-446655440050
                        checkpointId: 550e8400-e29b-41d4-a716-446655440051
                        companyId: 550e8400-e29b-41d4-a716-446655440000
                        name: Coverage Summary
                        number: FM-0011
                        category: event
                        storagePath: >-
                          acme/550e8400-.../formTemplates/550e8400-.../V-002/550e8400-....pdf
                        version: 2
                        kind: static
                        createdAt: '2026-07-01T10:00:00.000Z'
                        createdBy: 550e8400-e29b-41d4-a716-446655440099
                        updatedAt: '2026-07-02T11:00:00.000Z'
                        updatedBy: 550e8400-e29b-41d4-a716-446655440099
        '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
    page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number (1-based, default 1).
    pageSize50:
      name: pageSize
      in: query
      schema:
        type: integer
        minimum: 1
        default: 50
      description: Number of records per page (default 50).
  schemas:
    Fmv1FormSummary:
      description: >-
        A form-library entry: a form-template summary augmented with its current
        `version` and its `kind` (DOCX template vs static PDF).
      allOf:
        - $ref: '#/components/schemas/Fmv1FormTemplateSummary'
        - type: object
          required:
            - version
            - kind
          properties:
            version:
              type: integer
              description: The current checkpoint's version number.
            kind:
              type: string
              enum:
                - template
                - static
              description: >-
                `template` — a DOCX form template (carries smart tags); `static`
                — a static PDF used as-is. Selects which replace endpoint
                applies (`/forms/template/{number}` vs
                `/forms/static/{number}`).
    Fmv1FormTemplateSummary:
      type: object
      description: A single form-template checkpoint.
      required:
        - templateKey
        - checkpointId
        - companyId
        - name
        - number
        - category
        - storagePath
        - createdAt
        - updatedAt
      properties:
        templateKey:
          type: string
          format: uuid
          description: Stable identifier of the template across its versions.
        checkpointId:
          type: string
          format: uuid
          description: Identifier of this specific checkpoint (version) of the template.
        companyId:
          type: string
          format: uuid
        name:
          type: string
          description: Display name (derived from the uploaded file name).
        number:
          type: string
          description: Human-facing form number (e.g. `FM-0010`).
        category:
          type: string
          enum:
            - event
            - quote-flow
            - quote-bind-flow
            - unknown
          description: The form category assigned to the template.
        storagePath:
          type: string
          description: Internal storage key of the checkpoint's document.
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
          nullable: true
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
          nullable: true
    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.

````