Get a vehicle

Returns one vehicle of the application's organization, by its id or by its license plate. The vehicle can be saved or unsaved.

Input. Pass exactly one of vehicleId (a number from List vehicles) and licensePlate. A license plate is matched ignoring case, spaces, tabs, line breaks and dashes, so AB-123 C finds ab123c.

Response. 200 with the vehicle. saved tells a saved vehicle from an unsaved one: an unsaved vehicle is a license plate that cameras of the organization read with high confidence in the last 7 days and that is not saved. Its vehicleId stays the same when it is saved.

Notes. A private vehicle that is not shared with the access token answers 404, like a vehicle that does not exist. Time fields are Unix epoch milliseconds, UTC.

Request examples

GET /v3/vehicle-api/vehicle?vehicleId=1093527491036451
GET /v3/vehicle-api/vehicle?licensePlate=AB-123-CD

Required scope: read:vehicles

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
1 to 9007199254740991

The numeric id of the vehicle, from List vehicles. Pass this or licensePlate, not both.

string
length ≤ 20

The license plate of the vehicle, matched ignoring case, spaces, tabs, line breaks and dashes. Pass this or vehicleId, not both.

Responses

400

Both or neither of vehicleId and licensePlate were passed, vehicleId is not a positive integer, or licensePlate has fewer than 2 characters other than spaces, tabs, line breaks and dashes, or more than 20 characters.

404

Vehicle not found in this organization.

429

Too many requests. Try again later.

500

Internal server error.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*