API reference
GET /v1/deals
List deals
List deals
Cursor-paginated deals of the tenant with filters and search. Financial data (margin, items, payments) is never returned. Requires scope write:deals.
- Authentication: header
Authorization: Bearer rv_live_...(API keys and scopes) - Required scope:
write:deals
Descriptions of the operation, parameters and fields come from the OpenAPI specification (
openapi.json).Parameters
| Field | In | Type | Required | Description |
|---|---|---|---|---|
q | query | string | no | Deal number, VIN fragment, client name or vehicle make/model. |
status | query | string | no | Comma-separated deal statuses. |
open_only | query | "true" | "false" | no | Exclude closed/lost/cancelled. |
contact_id | query | string (uuid) | no | |
manager_id | query | string (uuid) | no | |
type | query | string | no | Comma-separated: full_service,auction_only,logistics_only,resale. |
sort | query | "createdAt" | "updatedAt" | "number" | "etaDelivery" | no | |
dir | query | "asc" | "desc" | no | |
cursor | query | string | no | |
limit | query | integer | no |
Responses
200
A page of deals.
application/json · Schema: DealPage
| Field | Type | Required | Description |
|---|---|---|---|
items | object[] | yes | |
items[].id | string (uuid) | no | |
items[].number | string | no | |
items[].status | "lead" | "consult" | "contract_signed" | "deposit_paid" | "searching" | "bid_approved" | "won" | "paid_to_auction" | "pickup_scheduled" | "at_us_warehouse" | "loaded" | "in_transit_sea" | "at_eu_port" | "inland_to_border" | "customs_clearing" | "customs_cleared" | "certification" | "registration" | "ready_for_handover" | "handed_over" | "closed" | "lost" | "cancelled" | "on_hold" | "dispute" | no | |
items[].type | "full_service" | "auction_only" | "logistics_only" | "resale" | no | |
items[].currency | "UAH" | "USD" | "EUR" | "PLN" | "GEL" | no | |
items[].contactId | string (uuid) | no | |
items[].contactName | string | null | no | |
items[].managerId | string | null (uuid) | no | |
items[].managerName | string | null | no | |
items[].vehicle | object | no | |
items[].etaDelivery | string | null | no | ISO 8601 date-time (UTC). |
items[].sla | object | no | |
items[].createdAt | string | no | ISO 8601 date-time (UTC). |
items[].updatedAt | string | no | ISO 8601 date-time (UTC). |
nextCursor | string | null | yes |
400
Invalid request parameters or body (code validation_error).
application/problem+json · Schema: Problem
401
Missing, malformed, unknown, revoked or expired API key (code unauthorized).
application/problem+json · Schema: Problem
403
The API key lacks the scope required by this endpoint (code insufficient_scope).
application/problem+json · Schema: Problem
422
Invalid filter.
application/problem+json · Schema: Problem
429
Rate limit exceeded for the tenant plan (code rate_limited). Wait Retry-After seconds.
application/problem+json · Schema: Problem