Returns one vehicle of the organization the API key belongs to, 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 API key answers 404, like a vehicle that does not exist. Time fields are Unix epoch milliseconds, UTC.
Request examples
GET /v1/vehicle-api/vehicle?vehicleId=1093527491036451
GET /v1/vehicle-api/vehicle?licensePlate=AB-123-CD| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
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.
Missing or invalid API key.
Forbidden - Insufficient permissions to access this resource
Vehicle not found in this organization.
Too many requests. Try again later.
Internal server error.