Sign in

v1

latestOpenAPI 3.1.02026-07-22370342.6 KB
Vehicles

Get Vehicle

Get the details of a specific vehicle

get/vehicles/{id}

Query parameters

rawboolean

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

expand'groups' | 'devices' | 'devices,groups' | 'groups,devices'

Expand resources in the returned response

Headers

X-Application-Idstring

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-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

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

Response

OK

idstring ulid required

Unique identifier for the vehicle in Terminal.

sourceIdstring required

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

providerstring required

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

status'active' | 'inactive' required

The status in the providers system

vinstring
namestring
makestring
modelstring
yearinteger
fuelType'gasoline' | 'diesel' | 'propane' | 'electric' | 'hybrid_gasoline' | 'hybrid_diesel' | 'biodiesel' | 'compressed_natural_gas' | 'liquefied_natural_gas' | 'ethanol' | 'hydrogen' | 'plug_in_hybrid'
fuelEfficiencynumber

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

fuelTankCapacitynumber

Maximum amount of fuel vehicle can hold in liters.

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

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

Example response

{
  "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_61D9ZWFGHVJ858NBF2Q7DV9MNC"
  ],
  "licensePlate": {
    "state": "TN",
    "number": "ABC-1234"
  },
  "fuelType": "diesel",
  "fuelEfficiency": 27.4,
  "fuelTankCapacity": 95.33,
  "metadata": {
    "visibility": "visible"
  },
  "raw": []
}