Skip to main content
GET
Get Vehicle

Authorizations

Authorization
string
header
required

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

Headers

X-Application-Id
string

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Connection-Token
string
required

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

Pattern: ^con_tkn_\S+$
Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Path Parameters

id
string<ulid>
required

Unique identifier for the vehicle in Terminal.

Pattern: ^vcl_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

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,
devices,
devices,groups,
groups,devices

Response

OK

id
string<ulid>
required

Unique identifier for the vehicle in Terminal.

Pattern: ^vcl_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

sourceId
string
required

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

Example:

"123456789"

provider
string
required

Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.

Example:

"geotab"

status
enum<string>
required

The status in the providers system

Available options:
active,
inactive
Example:

"active"

metadata
CoreEntityMetadata · object
required

Internal metadata about the record.

vin
string
Example:

"1HGCM82633A004352"

name
string
Example:

"Big Red"

make
string
Example:

"Peterbilt"

model
string
Example:

"Model 579"

year
integer
Example:

2016

groups
(string<ulid> | Expanded Group · object)[]

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

Example:

"group_01D8ZQFGHVJ858NBF2Q7DV9MNC"

devices
(string<ulid> | Expanded Device · object)[]

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

Example:

"dvc_01D8ZQFGHVJ858NBF2Q7DV9MNC"

licensePlate
object
fuelType
enum<string>
Available options:
gasoline,
diesel,
propane,
electric,
hybrid_gasoline,
hybrid_diesel,
biodiesel,
compressed_natural_gas,
liquefied_natural_gas,
ethanol,
hydrogen,
plug_in_hybrid
Example:

"diesel"

fuelEfficiency
number
deprecated

This field will be removed in the future as is not commonly available from providers.

Example:

27.4

fuelTankCapacity
number

Maximum amount of fuel vehicle can hold in liters.

Example:

95.33

createdAt
string<date-time>

The date and time the record was created in the provider's system. This timestamp comes directly from the source system and represents when the data was originally created there. Note: not all providers expose this.

updatedAt
string<date-time>

The date and time the record was updated in the provider's system. This timestamp comes directly from the source system and represents when the data was last updated there. Note: not all providers expose this.

raw
RawData · object[]
Example: