Vehicles
List Vehicles
List all of the vehicles in the connected account
GET
/
vehicles
Authorization
Header
Query
curl --request GET \
--url https://api.withterminal.com/tsp/v1/vehicles \
--header 'Authorization: <authorization>' \
--header 'Connection-Token: <connection-token>'
{
"results": [
{
"id": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
"name": "Big Red",
"status": "active",
"sourceId": "123456789",
"provider": "geotab",
"vin": "1HGCM82633A004352",
"make": "Peterbilt",
"model": "Model 579",
"year": 2016,
"groups": [],
"licensePlate": {},
"raw": []
}
],
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Connection-Token
string
requiredThe token returned when a user authenticated their account. This authorizes access to a specific account.
Query Parameters
cursor
string
Pagination cursor to start requests from
limit
integer
The maximum number of results to return in a page.
modifiedAfter
string
Only include records that were last modified after a provided date.
modifiedBefore
string
Only include records that were last modified before a provided date.
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
results
object[]
requirednext
string
Cursor used for pagination.
curl --request GET \
--url https://api.withterminal.com/tsp/v1/vehicles \
--header 'Authorization: <authorization>' \
--header 'Connection-Token: <connection-token>'
{
"results": [
{
"id": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
"name": "Big Red",
"status": "active",
"sourceId": "123456789",
"provider": "geotab",
"vin": "1HGCM82633A004352",
"make": "Peterbilt",
"model": "Model 579",
"year": 2016,
"groups": [],
"licensePlate": {},
"raw": []
}
],
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}