Vehicle

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

Vehicle Management APIs

POST/1/vehicles

Create Vehicle

Create a new vehicle linked to a user and account.

Authorization

User sessionAPI credential

Permissions

vehicles:write

OAuth

Request

Request bodyapplication/json

accountIdstringREQUIRED

licensePlatestring

userIdstringREQUIRED

vinstring

Responses

200Vehicle Created application/json

dataVehicle

accountIdstringREQUIRED

createdAtstring <date-time>

deletedboolean

deletedAtstring <date-time>

fleetIdstring

idstringREQUIRED

identifierstring

licensePlatestring

providerIdstringREQUIRED

updatedAtstring <date-time>

userIdstring

The assigned owner; null when unassigned. A vehicle belongs to at most one user.

vinstring

metaobject

limitnumber

skipnumber

statsobject

totalnumber

400Invalid Request application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

401Unauthorized application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

403Forbidden: missing a required permission, or no access to this resource application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

404Not Found application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

500Internal server error application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

POST/1/vehicles/search

Search for Vehicles

Authorization

User sessionAPI credential

Permissions

vehicles:read

OAuth

Request

Request bodyapplication/json

accountIdstring

licensePlatestring

limitnumber

default 50

skipnumber

default 0

sortobject

default {"field":"createdAt","order":"desc"}

fieldstringREQUIRED

orderstringREQUIRED

ascdesc

userIdstring

vinstring

Responses

200Vehicles application/json

dataVehicle[]

accountIdstringREQUIRED

createdAtstring <date-time>

deletedboolean

deletedAtstring <date-time>

fleetIdstring

idstringREQUIRED

identifierstring

licensePlatestring

providerIdstringREQUIRED

updatedAtstring <date-time>

userIdstring

The assigned owner; null when unassigned. A vehicle belongs to at most one user.

vinstring

metaobject

limitnumber

skipnumber

statsobject

totalnumber

400Invalid Request application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

401Unauthorized application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

403Forbidden: missing a required permission, or no access to this resource application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

404Not Found application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

500Internal server error application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

GET/1/vehicles/{id}

Get Vehicle

Authorization

User sessionAPI credential

Permissions

vehicles:read

OAuth

Request

Path parameters1

idstringREQUIRED

Responses

200Vehicle application/json

dataVehicle

accountIdstringREQUIRED

createdAtstring <date-time>

deletedboolean

deletedAtstring <date-time>

fleetIdstring

idstringREQUIRED

identifierstring

licensePlatestring

providerIdstringREQUIRED

updatedAtstring <date-time>

userIdstring

The assigned owner; null when unassigned. A vehicle belongs to at most one user.

vinstring

metaobject

limitnumber

skipnumber

statsobject

totalnumber

400Invalid Request application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

401Unauthorized application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

403Forbidden: missing a required permission, or no access to this resource application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

404Not Found application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

500Internal server error application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

PATCH/1/vehicles/{id}

Update Vehicle

Updates Vehicle with partial data.

Authorization

User sessionAPI credential

Permissions

vehicles:write

OAuth

Request

Path parameters1

idstringREQUIRED

Request bodyapplication/json

accountIdstring

licensePlatestring

userIdstring

vinstring

Responses

200Vehicle Patched application/json

dataVehicle

accountIdstringREQUIRED

createdAtstring <date-time>

deletedboolean

deletedAtstring <date-time>

fleetIdstring

idstringREQUIRED

identifierstring

licensePlatestring

providerIdstringREQUIRED

updatedAtstring <date-time>

userIdstring

The assigned owner; null when unassigned. A vehicle belongs to at most one user.

vinstring

metaobject

limitnumber

skipnumber

statsobject

totalnumber

400Invalid Request application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

401Unauthorized application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

403Forbidden: missing a required permission, or no access to this resource application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

404Not Found application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

500Internal server error application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

DELETE/1/vehicles/{id}

Delete Vehicle

Authorization

User sessionAPI credential

Permissions

vehicles:write

OAuth

Request

Path parameters1

idstringREQUIRED

Responses

204Vehicle Deleted text/plain

Returns a file (Text).

400Invalid Request application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

401Unauthorized application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

403Forbidden: missing a required permission, or no access to this resource application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

404Not Found application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

500Internal server error application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED