GET
/
vehicles
/
{vehicleId}
/
locations
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/vehicles/{vehicleId}/locations \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "results": [
    {
      "id": "vcl_loc_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "locatedAt": "2021-01-06T03:24:53.000Z",
      "location": {
        "longitude": -122.4194155,
        "latitude": 37.7749295
      },
      "address": {
        "formatted": "1.5 miles from Austin, TX"
      },
      "heading": 25,
      "speed": 95.33,
      "metadata": {
        "modifiedAt": "2023-11-07T05:31:56Z"
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Note:

Given the large volume of location data available, we encourage customers to accept compressed (gzip) responses in order to maximize throughput. This is supported with many popular HTTP clients. Result limits vary depending on if results are compressed or not.

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

​
vehicleId
string
required

Vehicle to retrieve breadcrumb locations for

Query Parameters

​
cursor
string

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

​
limit
integer

The maximum number of results to return in a page.

​
startAt
string

Timestamp to start from - defaults to beginning of history

Example:

"2021-01-06T03:24:53.000Z"

​
endAt
string

Timestamp to end at - defaults to now

Example:

"2021-01-06T03:24:53.000Z"

​
raw
boolean

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

Response

200
application/json

OK

The response is of type object.

GET
/
vehicles
/
{vehicleId}
/
locations
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/vehicles/{vehicleId}/locations \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "results": [
    {
      "id": "vcl_loc_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "locatedAt": "2021-01-06T03:24:53.000Z",
      "location": {
        "longitude": -122.4194155,
        "latitude": 37.7749295
      },
      "address": {
        "formatted": "1.5 miles from Austin, TX"
      },
      "heading": 25,
      "speed": 95.33,
      "metadata": {
        "modifiedAt": "2023-11-07T05:31:56Z"
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Note:

Given the large volume of location data available, we encourage customers to accept compressed (gzip) responses in order to maximize throughput. This is supported with many popular HTTP clients. Result limits vary depending on if results are compressed or not.

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

​
vehicleId
string
required

Vehicle to retrieve breadcrumb locations for

Query Parameters

​
cursor
string

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

​
limit
integer

The maximum number of results to return in a page.

​
startAt
string

Timestamp to start from - defaults to beginning of history

Example:

"2021-01-06T03:24:53.000Z"

​
endAt
string

Timestamp to end at - defaults to now

Example:

"2021-01-06T03:24:53.000Z"

​
raw
boolean

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

Response

200
application/json

OK

The response is of type object.