ImportOS · Docs
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

FieldInTypeRequiredDescription
qquerystringnoDeal number, VIN fragment, client name or vehicle make/model.
statusquerystringnoComma-separated deal statuses.
open_onlyquery"true" | "false"noExclude closed/lost/cancelled.
contact_idquerystring (uuid)no
manager_idquerystring (uuid)no
typequerystringnoComma-separated: full_service,auction_only,logistics_only,resale.
sortquery"createdAt" | "updatedAt" | "number" | "etaDelivery"no
dirquery"asc" | "desc"no
cursorquerystringno
limitqueryintegerno

Responses

200

A page of deals.

application/json · Schema: DealPage

FieldTypeRequiredDescription
itemsobject[]yes
items[].idstring (uuid)no
items[].numberstringno
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[].contactIdstring (uuid)no
items[].contactNamestring | nullno
items[].managerIdstring | null (uuid)no
items[].managerNamestring | nullno
items[].vehicleobjectno
items[].etaDeliverystring | nullnoISO 8601 date-time (UTC).
items[].slaobjectno
items[].createdAtstringnoISO 8601 date-time (UTC).
items[].updatedAtstringnoISO 8601 date-time (UTC).
nextCursorstring | nullyes

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

On this page