API referenceEndpoints
Search vehicles
Returns a page of vehicles matching optional text, carrier, type and status.
GET
/referential/v1/vehiclesReturns a page of vehicles matching optional text, carrier, type and status.
Authorization
oauth2 AuthorizationBearer <token>
In: header
Query Parameters
search?string
Matches part of a plate, fleet number or identifier value.
Default
nullcarrierId.value?string
fleetNumber?string
Matches part of a fleet number.
Default
nulltype?string
Vehicle category code; unknown is not-found.
Default
nullstatus?string
Vehicle lifecycle status.
Default
nullValue in
- "ACTIVE"
- "SUSPENDED"
permitCoversToday?boolean
Keep only vehicles a non-revoked permit covers today (true), or only those none covers (false); computed at read time.
Default
nullsort?string
Result ordering.
Default
nullValue in
- "plateAsc"
- "plateDesc"
- "newest"
- "oldest"
page?integer
Zero-based page index.
Format
int32Range
0 <= valueDefault
nullsize?integer
Page size, at most 200.
Format
int32Range
0 <= value <= 200Default
nullResponse Body
*/*
curl -X GET "https://example.com/referential/v1/vehicles"{ "data": [ { "id": "string", "carrierId": "string", "type": "string", "plateNumber": "string", "fleetNumber": "string", "brand": "string", "model": "string", "capacity": 0, "seatingMode": "string", "status": "string", "suspensionReason": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "page": 0, "size": 0, "total": 0}