OPEN API

Retrieve a vehicle

GET

http://127.0.0.1:8001/openapi/vehicles/{id}/

Vehicles

Get information about a specific vehicle.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

string <uuid>

read-onlyrequired

status

string

read-onlyrequired

Status of the vehicle

vin

string

required

<= 17 characters

name

string

required

Unit number of the vehicle

make

string | null

optional

<= 50 characters

model

string | null

optional

<= 100 characters

year

string

required

Year of the vehicle

licensePlate

object

required

License plate of the vehicle

state

string

required

State

number

string

required

Example

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "string",
  "vin": "string",
  "name": "string",
  "make": "string",
  "model": "string",
  "year": "string",
  "licensePlate": {
    "state": "string",
    "number": "string"
  }
}

List all vehicles

Historical Vehicle Locations