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"
  ],
  "devices": [
    "dvc_01D8ZQFGHVJ858NBF2Q7DV9MNC"
  ],
  "licensePlate": {
    "state": "TN",
    "number": "ABC-1234"
  },
  "fuelType": "gasoline",
  "fuelEfficiency": 27.4,
  "fuelTankCapacity": 95.33,
  "raw": []
}

Authorizations

​
Authorization
string
header
required

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.

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

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
OK
​
id
string
required
Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

​
sourceId
string
required

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

Example:

"123456789"

​
provider
enum<string>
required
Available options:
azuga,
bigroad,
conti-go,
eld-mandate,
eld-mandate-plus,
eld-mandate-hos,
eld-rider,
eldone,
envue-telematics,
eroad,
eva-eld,
attrix,
advantage-one,
argos,
fleet-profit-center,
gps-tracking-canada,
graybox-solutions,
gridline,
high-point-gps,
io-tab,
blue-arrow,
eagle-wireless,
fleet-complete-hub,
fleetistics,
fort-knox,
fm-eld,
geotab,
gofleet,
gogps,
gps-insight,
gpstab,
isaac,
ksk,
switchboard,
linxup,
coretex-360,
apollo,
apollo-eld,
apollo-compass,
top-tracking-system,
eld-mandate-prime,
hos-reporter-plus,
hos247,
black-bear,
columbus-eld,
phoenix-eld,
route-eld,
reliable-eld,
trust-eld,
abc-eld,
tempus-eld,
vlog-eld,
just-eld,
factor-eld,
moonlight-eld,
daily-eld,
dfl-eld,
hero-eld,
infinity-eld,
ampm-eld,
forza-eld,
action-eld,
state-elog,
dy-eld,
cobra-eld,
flash-elogs,
renaissance-eld,
robinhood-eld,
sr-eld,
speedline-eld,
eld-2-go,
captain-eld,
ironman-eld,
powertrucks-eld,
paragon-eld,
youlog-eld,
legacy-eld,
master-eld,
monarch-tracking,
motive,
mountain-eld,
omnitracs-es,
omnitracs-xrs,
omnitracs,
one-step-gps,
optima-eld,
pro-ride-eld,
pti-eld,
real-eld,
right-trucking,
roadstar,
routemate,
samsara,
sandbox,
sparkle-eld,
tx-eld,
surfsight,
tfm-eld,
transflo,
truckx,
tt-eld,
verizon-fleet,
verizon-reveal,
verizon,
webfleet,
xeld,
xplore-eld,
zonar,
geotab-att,
zippy-eld,
evo-eld,
ontime-eld,
intelli-shift,
id-eld,
max-eld,
asrit-solutions,
smartelds,
eld-books,
vulcansols,
motion-eld,
blue-horse-eld,
apex-ultima,
radical-eld,
rock-eld,
lytx,
blue-ink,
utech,
light-and-travel-eld,
lion-eight,
pop-eld,
netradyne,
people-net
Example:

"geotab"

​
status
enum<string>
required

The status in the providers system

Available options:
active,
inactive
​
vin
string
Example:

"1HGCM82633A004352"

​
name
string
Example:

"Big Red"

​
make
string
Example:

"Peterbilt"

​
model
string
Example:

"Model 579"

​
year
integer
Example:

2016

​
groups
array

Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.

​
devices
array

Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.

​
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.

Example:

27.4

​
fuelTankCapacity
number

Maximum amount of fuel vehicle can hold in liters.

Example:

95.33

​
raw
object[]

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

Raw data fetched from the source provider. Most of our endpoints support a raw query parameter that will append a list of the raw requests used to form our common model. This can be helpful for leveraging unique fields that are not part of our unified model.

Example:
[]
List VehiclesLatest Vehicle Locations