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

# List Policies

> Returns a paginated list of policies for the company.

**Filtering:**
- `primaryInsuredId` - Filter by primary insured ID
- `filterText` - Text search across policy number and other fields

**Sorting:**
- `createdAt` (default), `updatedAt`, `number`, `startsAtDate`, `endsAtDate`

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




## OpenAPI

````yaml /openapi/generated-external-api.yaml get /api/external/companies/{companyId}/policies
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://app.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/external/companies/{companyId}/policies:
    get:
      tags:
        - Policies
      summary: List Policies
      description: >
        Returns a paginated list of policies for the company.


        **Filtering:**

        - `primaryInsuredId` - Filter by primary insured ID

        - `filterText` - Text search across policy number and other fields


        **Sorting:**

        - `createdAt` (default), `updatedAt`, `number`, `startsAtDate`,
        `endsAtDate`


        **Required permission:** `company.policy:read`
      operationId: listPolicies
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/primaryInsuredId'
        - $ref: '#/components/parameters/filterText'
        - $ref: '#/components/parameters/policySortBy'
        - $ref: '#/components/parameters/sortDirection'
        - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: Paginated list of policies
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PolicyListItem'
                  totalCount:
                    type: integer
                    description: Total number of matching policies across all pages
              examples:
                success:
                  summary: List of policies
                  value:
                    items:
                      - id: 550e8400-e29b-41d4-a716-446655440100
                        companyId: 550e8400-e29b-41d4-a716-446655440000
                        number: POL-2025-001
                        createdAt: '2025-01-15T10:30:00.000Z'
                        primaryInsuredId: 550e8400-e29b-41d4-a716-446655440200
                      - id: 550e8400-e29b-41d4-a716-446655440101
                        companyId: 550e8400-e29b-41d4-a716-446655440000
                        number: POL-2025-002
                        createdAt: '2025-01-16T14:20:00.000Z'
                        primaryInsuredId: 550e8400-e29b-41d4-a716-446655440201
                    totalCount: 42
        '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
    primaryInsuredId:
      name: primaryInsuredId
      in: query
      schema:
        type: string
        format: uuid
      description: Filter by primary insured ID
    filterText:
      name: filterText
      in: query
      schema:
        type: string
      description: Search across quote number, description, and other text fields
    policySortBy:
      name: sortBy
      in: query
      schema:
        type: string
        enum:
          - createdAt
          - updatedAt
          - number
          - startsAtDate
          - endsAtDate
        default: createdAt
      description: Field to sort by (default createdAt)
    sortDirection:
      name: sortDirection
      in: query
      schema:
        type: string
        enum:
          - asc
          - desc
        default: desc
      description: Sort direction (default desc)
    page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number (1-based, default 1, page size 50)
  schemas:
    PolicyListItem:
      type: object
      description: A policy item returned from the list endpoint
      properties:
        id:
          type: string
          format: uuid
          description: Policy identifier
        companyId:
          type: string
          format: uuid
          description: Company identifier
        number:
          type: string
          description: Policy number
        createdAt:
          type: string
          format: date-time
          description: When the policy was created (ISO 8601)
        primaryInsuredId:
          type: string
          format: uuid
          nullable: true
          description: ID of the primary insured on this policy
    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'
            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: UNAUTHORIZED
                  message: Authorization header is required
            bearerTokenNotAllowed:
              summary: Bearer token used instead of API key
              value:
                error:
                  code: UNAUTHORIZED
                  message: External API endpoints require API key authentication
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: FORBIDDEN
                  message: Insufficient permissions to perform this action
    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: INTERNAL_ERROR
                  message: An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Include your API key in the Authorization
        header.

````