Skip to main content
GET
Retrieve a vehicle

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Path Parameters

id
string<uuid>
required

ID of the vehicle object to be retrieved.

Response

200 - application/json
id
string<uuid>

Unique ID of the vehicle.

account
string<uuid>

ID of the account associated with the vehicle.

identification
string

License plate number or similar vehicle identifier.

make
string

Vehicle brand or manufacturer.

model
string

Vehicle model.

type
enum<string>

The type of vehicle.

Available options:
car,
pedestrian,
ebike,
bicycle,
scooter,
motorcycle,
other
year
string

Year the vehicle was made.

vin
string

Vehicle Identification Number (VIN).

employer
string

Name of the user's employer.

created_at
string<date-time>

Timestamp (ISO 8601) when the vehicle object was created.

updated_at
string<date-time>

Timestamp (ISO 8601) when a property value of the vehicle object most recently changed.

metadata
object

Additional, non-categorized information.