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>'
import requests

url = "https://api.withterminal.com/tsp/v1/vehicles/{id}"

headers = {
"Connection-Token": "<connection-token>",
"Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {'Connection-Token': '<connection-token>', Authorization: 'Bearer <token>'}
};

fetch('https://api.withterminal.com/tsp/v1/vehicles/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withterminal.com/tsp/v1/vehicles/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Connection-Token: <connection-token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.withterminal.com/tsp/v1/vehicles/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Connection-Token", "<connection-token>")
req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.withterminal.com/tsp/v1/vehicles/{id}")
.header("Connection-Token", "<connection-token>")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.withterminal.com/tsp/v1/vehicles/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Connection-Token"] = '<connection-token>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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": "diesel",
  "fuelEfficiency": 27.4,
  "fuelTankCapacity": 95.33,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "raw": []
}
{
"code": "bad_request",
"message": "Invalid request body",
"detail": [
{
"message": "'vehicleId' property must be a valid ulid",
"path": "{requestQuery}.vehicleId",
"suggestion": "Please ensure you submit a valid 'vehicleId' property",
"context": {}
}
]
}
{
"code": "unauthorized",
"message": "Unauthorized Request",
"detail": "Please ensure you have a valid API key"
}
{
"code": "forbidden",
"message": "Forbidden Request",
"detail": "Please ensure the connection token matches the resource you are attempting to access."
}
{
"code": "not_found",
"message": "Resource not found",
"detail": "Could not find resource with ID: 2342342"
}
{
"code": "too_many_requests",
"message": "Too Many Requests",
"retryAfter": 60,
"detail": "You have exceeded your rate limit. Please try again later."
}
{
"code": "internal_server_error",
"message": "Internal Server Error",
"detail": "Something went wrong"
}
{
"code": "gateway_timeout",
"message": "Gateway Timeout"
}

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.

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