> ## 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 Form Packets

> Lists the form packets issued on one quote or policy, newest first. A
quote gets a packet each time it leaves in progress, by being completed or
bound, so a quote that has never left in progress has none. A policy gets
one packet per bind (new business, endorsement, renewal…) and one per set
issued from Generate Policy Forms.

Pass a packet's `id` to
[Get Form Packet Download URL](./get-form-packet-download-url) to
download its PDF.

**Required permission:** `form.view`, plus `quote.view` or `policy.view`
for the record named by `entityType`.




## OpenAPI

````yaml /openapi/generated-external-api.yaml get /api/v1/companies/{companyId}/forms/packets
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/packets:
    get:
      tags:
        - Forms
      summary: List Form Packets
      description: >
        Lists the form packets issued on one quote or policy, newest first. A

        quote gets a packet each time it leaves in progress, by being completed
        or

        bound, so a quote that has never left in progress has none. A policy
        gets

        one packet per bind (new business, endorsement, renewal…) and one per
        set

        issued from Generate Policy Forms.


        Pass a packet's `id` to

        [Get Form Packet Download URL](./get-form-packet-download-url) to

        download its PDF.


        **Required permission:** `form.view`, plus `quote.view` or `policy.view`

        for the record named by `entityType`.
      operationId: listFormPackets
      parameters:
        - $ref: '#/components/parameters/companyId'
        - name: entityType
          in: query
          required: true
          schema:
            type: string
            enum:
              - quote
              - policy
          description: The type of record the packets were issued on.
        - name: entityId
          in: query
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            The quote's or policy's id. An id with no packets returns an empty
            list.
      responses:
        '200':
          description: The record's packets, newest first.
          content:
            application/json:
              schema:
                type: object
                required:
                  - packets
                properties:
                  packets:
                    type: array
                    items:
                      $ref: '#/components/schemas/Fmv1FormPacketSummary'
              examples:
                policyPackets:
                  summary: A policy's bind packet and a later issued set
                  value:
                    packets:
                      - id: 550e8400-e29b-41d4-a716-446655440071
                        origin: Issued
                        status: issued
                        issuedAt: '2026-10-20T15:05:00.000Z'
                        forms:
                          - formId: 550e8400-e29b-41d4-a716-446655440082
                            name: Cover Letter
                      - id: 550e8400-e29b-41d4-a716-446655440070
                        origin: Bind
                        status: issued
                        issuedAt: '2026-10-01T14:30:00.000Z'
                        forms:
                          - formId: 550e8400-e29b-41d4-a716-446655440080
                            name: Declarations
                          - formId: 550e8400-e29b-41d4-a716-446655440081
                            name: Policy Jacket
        '400':
          description: Bad Request - `entityType` or `entityId` is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidEntityType:
                  summary: An entity type that carries no packets
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: >-
                        entityType: Invalid option: expected one of
                        "quote"|"policy"
                      userMessages:
                        - 'Invalid option: expected one of "quote"|"policy"'
                      details:
                        - field: entityType
                          message: 'Invalid option: expected one of "quote"|"policy"'
        '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
  schemas:
    Fmv1FormPacketSummary:
      description: >-
        A form packet: the documents issued together at one moment of a quote's
        or policy's life, merged into one PDF.
      type: object
      required:
        - id
        - origin
        - status
        - issuedAt
        - forms
      properties:
        id:
          type: string
          format: uuid
          description: The packet's id, for Get Form Packet Download URL.
        origin:
          type: string
          description: >-
            What issued the packet, as the app's Forms tab tags it. On a quote,
            `Quote` when the quote was completed, or `Bind` when it was bound
            straight from in progress. On a policy, `Bind`, `Endorsement`,
            `Renewal`, `Cancellation`, or `Reinstatement` for a transaction's
            bind, and `Issued` for a set issued from Generate Policy Forms. An
            older packet someone assembled by hand reads `Manual`.
        status:
          type: string
          enum:
            - issued
            - pending
            - failed
          description: >-
            `issued` packets download. `pending` means the PDF is still being
            rendered, usually for a few seconds after a bind or an issuance. The
            app's Forms tab shows one still `pending` after 10 minutes as failed
            and offers a retry. `failed` means rendering failed; retry it from
            the app's Forms tab.
        issuedAt:
          type: string
          format: date-time
          description: The moment the packet records, such as the quote's bind.
        forms:
          type: array
          description: The packet's documents, in page order.
          items:
            type: object
            required:
              - formId
              - name
            properties:
              formId:
                type: string
                format: uuid
                description: >-
                  The generated form the document was issued from. The form may
                  since have been deleted; the packet keeps its document.
              name:
                type: string
                description: The document's name when the packet was issued.
    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
                  code:
                    type: string
                    description: Stable problem code for this individual validation failure
                    example: BLANK_LIST_ELEMENT
                  reason:
                    type: string
                    description: Stable reason the value violates its canonical contract
                    example: blank-list-element
                  expected:
                    type: string
                    description: The expected canonical value contract
                    example: nonblank trimmed string
                  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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.