Skip to main content
GET
/
policies
List policies
curl --request GET \
  --url https://sandbox.yasmina.ai/api/v1/car-comp/policies \
  --header 'Authorization: Bearer <token>'
{
  "current_page": 123,
  "data": [
    {
      "id": 123,
      "meta_data": {},
      "start_date": "<string>",
      "provider_policy_id": 123,
      "provider_policy": "<string>",
      "order_status": 123,
      "approval_status": 123,
      "end_date": "<string>",
      "is_claimed": true,
      "created_at": "<string>",
      "uploaded_at": "2023-11-07T05:31:56Z",
      "updated_at": "<string>",
      "client_id": "<string>",
      "canceled_at": "<string>",
      "invoice": "<string>",
      "cancellation_document": "<string>"
    }
  ],
  "first_page_url": "<string>",
  "from": 123,
  "last_page": 123,
  "last_page_url": "<string>",
  "links": [
    {
      "url": "<string>",
      "label": "<string>",
      "active": true
    }
  ],
  "next_page_url": "<string>",
  "path": "<string>",
  "per_page": 123,
  "prev_page_url": "<string>",
  "to": 123,
  "total": 123,
  "aggregates": {
    "total_count": 12,
    "total_price": 42850.75,
    "by_month": {
      "2026-06": {
        "count": 12,
        "total_price": 42850.75
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme

Query Parameters

​
quote_request_id
integer
​
quote_price_id
string<uuid>
​
provider_policy_id
integer
​
car_sequence_number
string
​
new_owner_id
string
​
previous_owner_id
string
​
status
integer
​
min_price
number
​
max_price
number
​
per_page
integer
Required range: x >= 1
​
date_from
string<date>

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.

Example:

"2026-06-01"

​
date_to
string<date>

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.

Example:

"2026-06-30"

​
include_aggregates
boolean

When true, includes policy totals, total price, and monthly buckets for the filtered result set.

Example:

true

Response

Success

​
current_page
integer
​
data
object[]
​
first_page_url
string
​
from
integer | null
​
last_page
integer
​
last_page_url
string
​
links
object[]
​
next_page_url
string | null
​
path
string
​
per_page
integer
​
prev_page_url
string | null
​
to
integer | null
​
total
integer
​
aggregates
object

Returned only when include_aggregates is true.