Skip to main content
GET
/
vehicles
/
{id}
Get Vehicle
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",
  "metadata": {
    "addedAt": "2023-11-07T05:31:56Z",
    "modifiedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "visibility": "visible"
  },
  "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,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "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

OK

​
id
string<ulid>
required

Unique identifier for the vehicle in Terminal.

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
​
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
​
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:
[]