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

# List policies

> Listing requested policies



## OpenAPI

````yaml /car-api-reference/openapi.json get /policies
openapi: 3.0.1
info:
  title: OpenAPI For Motor Insurance
  description: API's that you need to use to issue insurance policies to your clients
  license:
    name: MIT
  version: 1.0.0
servers:
  - x-fern-server-name: Sandbox
    url: https://sandbox.yasmina.ai/api/v1/car-comp
  - x-fern-server-name: Production
    url: https://production.yasmina.ai/api/v1/car-comp
security:
  - Oauth2: []
paths:
  /policies:
    get:
      tags:
        - Policies
      summary: List policies
      description: Listing requested policies
      parameters:
        - name: quote_request_id
          in: query
          schema:
            type: integer
        - name: quote_price_id
          in: query
          schema:
            type: string
            format: uuid
        - name: provider_policy_id
          in: query
          schema:
            type: integer
        - name: car_sequence_number
          in: query
          schema:
            type: string
        - name: new_owner_id
          in: query
          schema:
            type: string
        - name: previous_owner_id
          in: query
          schema:
            type: string
        - name: status
          in: query
          schema:
            type: integer
        - name: min_price
          in: query
          schema:
            type: number
        - name: max_price
          in: query
          schema:
            type: number
        - name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
        - name: date_from
          in: query
          description: >-
            Inclusive lower bound for the policy date. For issued policies
            (`status=1`), this filters by `uploaded_at` (the provider policy
            issue timestamp) and falls back to `created_at` when `uploaded_at`
            is unavailable. For other statuses, this filters by `created_at`.
          schema:
            type: string
            format: date
            example: '2026-06-01'
        - name: date_to
          in: query
          description: >-
            Inclusive upper bound for the policy date. For issued policies
            (`status=1`), this filters by `uploaded_at` (the provider policy
            issue timestamp) and falls back to `created_at` when `uploaded_at`
            is unavailable. For other statuses, this filters by `created_at`.
          schema:
            type: string
            format: date
            example: '2026-06-30'
        - name: include_aggregates
          in: query
          description: >-
            When true, includes policy totals, total price, and monthly buckets
            for the filtered result set.
          schema:
            type: boolean
            example: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPolicyResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    PaginatedPolicyResponse:
      type: object
      properties:
        current_page:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/Policy'
        first_page_url:
          type: string
        from:
          type: integer
          nullable: true
        last_page:
          type: integer
        last_page_url:
          type: string
        links:
          type: array
          items:
            $ref: '#/components/schemas/PaginationLink'
        next_page_url:
          type: string
          nullable: true
        path:
          type: string
        per_page:
          type: integer
        prev_page_url:
          type: string
          nullable: true
        to:
          type: integer
          nullable: true
        total:
          type: integer
        aggregates:
          $ref: '#/components/schemas/PolicyAggregates'
    Policy:
      type: object
      properties:
        id:
          type: integer
        meta_data:
          type: object
        start_date:
          type: string
        provider_policy_id:
          type: integer
        provider_policy:
          type: string
        order_status:
          type: integer
        approval_status:
          type: integer
        end_date:
          type: string
        is_claimed:
          type: boolean
        created_at:
          type: string
        uploaded_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Timestamp when the provider policy document was attached. For issued
            motor policies this is the closest available issue/purchase
            timestamp.
        updated_at:
          type: string
        client_id:
          type: string
        canceled_at:
          type: string
          nullable: true
        invoice:
          type: string
        cancellation_document:
          type: string
    PaginationLink:
      type: object
      properties:
        url:
          type: string
          nullable: true
        label:
          type: string
        active:
          type: boolean
    PolicyAggregates:
      type: object
      description: Returned only when include_aggregates is true.
      properties:
        total_count:
          type: integer
          example: 12
        total_price:
          type: number
          format: float
          example: 42850.75
        by_month:
          type: object
          description: >-
            Monthly policy counts and sales totals keyed by YYYY-MM. For issued
            policies (`status=1`), buckets use `uploaded_at` and fall back to
            `created_at`.
          additionalProperties:
            $ref: '#/components/schemas/PolicyMonthAggregate'
          example:
            2026-06:
              count: 12
              total_price: 42850.75
    PolicyMonthAggregate:
      type: object
      properties:
        count:
          type: integer
          example: 12
        total_price:
          type: number
          format: float
          example: 42850.75
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: string
                example: '40101'
              message:
                type: string
                example: Unauthenticated
  securitySchemes:
    Oauth2:
      description: JWT Authorization header using the Bearer scheme
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /oauth/token
          scopes: {}

````