GET
/
vehicles
/
{id}
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/vehicles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "id": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
  "sourceId": "123456789",
  "provider": "geotab",
  "status": "active",
  "vin": "1HGCM82633A004352",
  "name": "Big Red",
  "make": "Peterbilt",
  "model": "Model 579",
  "year": 2016,
  "groups": [
    "group_01D8ZQFGHVJ858NBF2Q7DV9MNC"
  ],
  "licensePlate": {
    "state": "TN",
    "number": "ABC-1234"
  },
  "fuelType": "gasoline",
  "fuelEfficiency": 27.4,
  "fuelTankCapacity": 95.33,
  "raw": []
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Connection-Token
string
required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Path Parameters

id
string
required

Query Parameters

raw
boolean

Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.

expand
enum<string>

Expand resources in the returned response

Available options:
groups

Response

200 - application/json
id
string
required
sourceId
string
required

The ID used to represent the entity in the source system.

provider
enum<string>
required
Available options:
sandbox,
samsara,
geotab,
gofleet,
gogps,
fleetistics,
envue-telematics,
motive,
isaac,
eroad,
verizon-reveal,
azuga,
webfleet,
surfsight,
gpstab,
fleet-complete-hub,
eld-rider,
eldone,
verizon-fleet,
zonar,
roadstar,
bigroad,
omnitracs-xrs,
omnitracs-es,
omnitracs,
verizon,
master-eld,
right-trucking,
real-eld,
tfm-eld,
fm-eld,
mountain-eld,
ksk,
truckx,
gps-insight
status
enum<string>
required

The status in the providers system

Available options:
active,
inactive
vin
string
name
string
make
string
model
string
year
integer
groups
array
licensePlate
object
fuelType
enum<string>
Available options:
gasoline,
diesel,
propane,
electric,
hybrid_gasoline,
hybrid_diesel
fuelEfficiency
number

Fuel efficiency measurement in liters per 100 km.

fuelTankCapacity
number

Maximum amount of fuel vehicle can hold in liters.

raw
object[]

List of the raw data used to normalize the common model. Response schemas will vary by provider.