WIwithterminal
Vehicles

List Vehicles

Changed on

List all of the vehicles in the connected account

get/vehicles

Request

  • Base URL
    https://api.withterminal.com/tsp/v1
  • URL
    https://api.withterminal.com/tsp/v1/vehicles
  • Auth
    HTTP bearer

Query parameters

cursorstring cursor
Example:cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Pagination cursor to start requests from

limitinteger

The maximum number of results to return in a page.

modifiedAfterstring date-time
Example:2021-01-06T03:24:53.000Z

Only include records that were last modified after a provided date.

modifiedBeforestring date-time
Example:2021-01-06T03:24:53.000Z

Only include records that were last modified before a provided date.

rawboolean

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

hiddenboolean

Show hidden records that don't match the configured filters. Defaults to false.

deletedboolean

Show "soft-deleted" records that have been deleted from the provider. Defaults to false.

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

nextstring cursor

Cursor used for pagination.

Example response

{
  "results": [
    {
      "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": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Changes

  • 71081936e1bdRevision changes
    • breaking

      added the pattern ^[A-Za-z0-9+/=_-]+$ to the query request parameter cursor

    • breaking

      added to the /// response property oneOf list for the response status

    • breaking

      added to the /// response property oneOf list for the response status

    • warning

      added the new provider_timeout enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      removed subschema #2: Expanded Device from the /// response property oneOf list for the response status

    • info

      removed subschema #2: Expanded Group from the /// response property oneOf list for the response status

    • info

      the response's property pattern ^[A-Za-z0-9+/=_-]+$ was added for the status