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

> Returns a paginated list of submissions for the company.
Filter by status, type, or search text.

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




## OpenAPI

````yaml /openapi/generated-external-api.yaml get /api/external/companies/{companyId}/submissions
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}/submissions:
    get:
      tags:
        - Submissions
      summary: List Submissions
      description: |
        Returns a paginated list of submissions for the company.
        Filter by status, type, or search text.

        **Required permission:** `company.submission:read`
      operationId: listSubmissions
      parameters:
        - $ref: '#/components/parameters/companyId'
        - name: status
          in: query
          schema:
            oneOf:
              - type: string
              - type: array
                items:
                  type: string
          description: >-
            Filter by status: in_progress, submitted, quote_in_progress, quoted,
            bound, declined, expired, cancelled
        - name: type
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - new_business
                - renewal
                - endorsement
                - cancellation
          description: Filter by submission type
        - $ref: '#/components/parameters/filterText'
        - $ref: '#/components/parameters/submissionSortBy'
        - $ref: '#/components/parameters/sortDirection'
        - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: Paginated list of submissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ListSubmission'
                  totalCount:
                    type: integer
                    description: Total number of matching submissions across all pages
              examples:
                success:
                  summary: List of submissions
                  value:
                    items:
                      - id: 550e8400-e29b-41d4-a716-446655440001
                        number: SUB-2024-001
                        name: Acme Corp Submission
                        status: quoted
                        type: new_business
                        primaryInsuredName: Acme Corporation
                        applicationId: 550e8400-e29b-41d4-a716-446655440010
                        createdAt: '2024-01-15T10:30:00.000Z'
                        updatedAt: '2024-01-16T14:20:00.000Z'
                      - id: 550e8400-e29b-41d4-a716-446655440002
                        number: SUB-2024-002
                        name: null
                        status: in_progress
                        type: renewal
                        primaryInsuredName: XYZ Healthcare
                        applicationId: 550e8400-e29b-41d4-a716-446655440011
                        createdAt: '2024-01-10T08:00:00.000Z'
                        updatedAt: null
                    totalCount: 150
        '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
    filterText:
      name: filterText
      in: query
      schema:
        type: string
      description: Search across quote number, description, and other text fields
    submissionSortBy:
      name: sortBy
      in: query
      schema:
        type: string
        enum:
          - createdAt
          - updatedAt
          - primaryInsuredName
          - number
          - status
          - type
        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:
    ListSubmission:
      type: object
      description: A submission as returned by the list endpoint (minimal fields)
      properties:
        id:
          type: string
          format: uuid
          description: Submission identifier
        number:
          type: string
          description: Submission number
        name:
          type: string
          nullable: true
          description: Submission name
        status:
          $ref: '#/components/schemas/SubmissionStatus'
        type:
          $ref: '#/components/schemas/SubmissionType'
        primaryInsuredName:
          type: string
          nullable: true
          description: Name of the primary insured
        applicationId:
          type: string
          format: uuid
          nullable: true
          description: Associated application ID
        createdAt:
          type: string
          format: date-time
          description: When the submission was created (ISO 8601)
        updatedAt:
          type: string
          format: date-time
          nullable: true
          description: When the submission was last updated (ISO 8601)
    SubmissionStatus:
      type: string
      enum:
        - in_progress
        - submitted
        - quote_in_progress
        - quoted
        - bound
        - declined
        - expired
        - cancelled
    SubmissionType:
      type: string
      description: Internal submission type
      enum:
        - new_business
        - renewal
        - endorsement
        - cancellation
        - reinstatement
    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.

````