> ## 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 Record Packet Emails

> Lists every email sent from the record's packets, newest first, with
each send's status. The app shows these under each packet on the Forms
tab.

Answers `404` while email is not turned on for the company.

**Required permission:** `<resource>.view` for the path's `{entityType}`
(`event.view`, `exposure.view` or `quote.view`).




## OpenAPI

````yaml /openapi/generated-external-api.yaml get /api/v1/companies/{companyId}/entities/{entityType}/{entityId}/packet-emails
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}/entities/{entityType}/{entityId}/packet-emails:
    get:
      tags:
        - Record Emails
      summary: List Record Packet Emails
      description: |
        Lists every email sent from the record's packets, newest first, with
        each send's status. The app shows these under each packet on the Forms
        tab.

        Answers `404` while email is not turned on for the company.

        **Required permission:** `<resource>.view` for the path's `{entityType}`
        (`event.view`, `exposure.view` or `quote.view`).
      operationId: listRecordPacketEmails
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/crudEntityType'
        - $ref: '#/components/parameters/entityIdPath'
      responses:
        '200':
          description: The emails, newest first
          content:
            application/json:
              schema:
                type: object
                required:
                  - items
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PacketEmail'
              examples:
                sent:
                  summary: One email sent with its packet
                  value:
                    items:
                      - deliveryId: 550e8400-e29b-41d4-a716-446655440601
                        packetId: 550e8400-e29b-41d4-a716-446655440501
                        threadId: 550e8400-e29b-41d4-a716-446655440603
                        subject: Your renewal quote for Acme Cafe
                        to:
                          - jill.ortiz@summit-brokers.example
                        status: sent
                        waitingOnPacket: false
                        reason: null
                        sentAt: '2026-11-09T10:00:04.000Z'
                        attachPacket: true
                        createdAt: '2026-11-09T10:00:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The record does not exist, or email is not turned on for the company
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                recordNotFound:
                  summary: Record not found
                  value:
                    error:
                      code: NotFoundError
                      message: Quote 550e8400-e29b-41d4-a716-446655440301 not found
                      userMessages:
                        - Quote 550e8400-e29b-41d4-a716-446655440301 not found
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
    crudEntityType:
      name: entityType
      in: path
      required: true
      schema:
        type: string
        enum:
          - event
          - exposure
          - quote
          - submission
          - person
          - organization
      description: >
        Field Model V1 entity type (lowercase kebab-case URL slug). One of the
        six

        CRUD entity types: `event`, `exposure`, `quote`, `submission`, `person`,

        `organization`. `policy` is NOT valid here — Policy has no generic CRUD
        (its

        writes go through the policy transaction endpoints), though it does have
        a

        read-only `/configuration` schema.
    entityIdPath:
      name: entityId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Entity identifier
  schemas:
    PacketEmail:
      type: object
      description: One email sent from one of the record's packets.
      required:
        - deliveryId
        - packetId
        - threadId
        - subject
        - to
        - status
        - waitingOnPacket
        - reason
        - sentAt
        - attachPacket
        - createdAt
      properties:
        deliveryId:
          type: string
          format: uuid
        packetId:
          type: string
          format: uuid
        threadId:
          type: string
          format: uuid
        subject:
          type: string
        to:
          type: array
          items:
            type: string
        status:
          $ref: '#/components/schemas/EmailDeliveryStatus'
        waitingOnPacket:
          type: boolean
          description: >-
            The send is `queued` and held until the packet whose PDF it attaches
            has finished issuing.
        reason:
          type: string
          nullable: true
          description: >-
            Why the send failed or bounced, in plain words; null unless `status`
            is `failed` or `bounced`.
        sentAt:
          type: string
          format: date-time
          nullable: true
        attachPacket:
          type: boolean
        createdAt:
          type: string
          format: date-time
          description: When the email was sent from the app.
    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
    EmailDeliveryStatus:
      type: string
      description: >-
        Where a send from the app stands: `queued` waits for a worker, `sending`
        is with the provider, `sent` was accepted, and `failed` did not go out.
        After `sent`, the provider reports `delivered` (the recipient's mail
        server took it), `bounced` (it refused it for good), or `complained` (a
        recipient marked it as spam). A bounce or complaint for any recipient
        overrides `delivered`.
      enum:
        - queued
        - sending
        - sent
        - failed
        - delivered
        - bounced
        - complained
  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.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0
        access token (audience = the app API audience) as `Authorization: Bearer
        <jwt>`. The request resolves to the user's identity and is authorized by
        their Role on the `{companyId}` in the path — the same role-based
        permissions the web app enforces. This is the path the MCP connector
        uses to act on a user's behalf; endpoints that accept it list both
        `BearerAuth` and `ApiKeyAuth`.

````

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