---
title: "List Vehicles"
method: GET
path: "/vehicles"
tags: ["Vehicles"]
---

# List Vehicles

`GET /vehicles`

List all of the vehicles in the connected account

## Query parameters

- `cursor` string, cursor
- `limit` integer
- `modifiedAfter` string, date-time
- `modifiedBefore` string, date-time
- `raw` boolean
- `hidden` boolean
- `deleted` boolean
- `expand` 'groups' | 'devices' | 'devices,groups' | 'groups,devices'

## Headers

- `X-Application-Id` string
- `Connection-Token` string, required

## Response `200`

OK

- object
  - `results` object[], required
    - `id` string, ulid, required — Unique identifier for the vehicle in Terminal.
    - `sourceId` string, required — The ID used to represent the entity in the source system.
    - `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](/providers).
    - `status` 'active' | 'inactive', required — The status in the providers system
    - `vin` string
    - `name` string
    - `make` string
    - `model` string
    - `year` integer
    - `groups` union[]
      - union — Entities in Terminal are expandable. Using the `expand` query parameter you can choose to ingest just an ID or the full entity details.
        - string, ulid
        - object
          - `id` string, ulid, required
    - `devices` union[]
      - union — Entities in Terminal are expandable. Using the `expand` query parameter you can choose to ingest just an ID or the full entity details.
        - string, ulid
        - object
          - `id` string, ulid, required
    - `licensePlate` object
      - `state` 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MP' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'VI' | 'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NS' | 'ON' | 'PE' | 'QC' | 'SK' | 'NT' | 'NU' | 'UM' | 'YT' | 'DC' — US State or Canadian Province
      - `number` string
    - `fuelType` 'gasoline' | 'diesel' | 'propane' | 'electric' | 'hybrid_gasoline' | 'hybrid_diesel' | 'biodiesel' | 'compressed_natural_gas' | 'liquefied_natural_gas' | 'ethanol' | 'hydrogen' | 'plug_in_hybrid'
    - `fuelEfficiency` number — This field will be removed in the future as is not commonly available from providers.
    - `fuelTankCapacity` number — Maximum amount of fuel vehicle can hold in liters.
    - `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.
    - `metadata` object, required — Internal metadata about the record.
      - `addedAt` string, date-time, required — The date and time the record was ingested into Terminal. Note: this is not the date and time the record was created in the provider's system.
      - `modifiedAt` string, date-time, required — The date and time the record was last updated in Terminal. Note: this is not the date and time the record was updated in the provider's system.
      - `deletedAt` string, date-time — The date and time the record was deleted from Terminal. Note: this is not the date and time the record was deleted in the provider's system.
      - `visibility` 'visible' | 'hidden_by_exclude_list' | 'hidden_by_include_list' | 'hidden_by_status' | 'deleted' — Visibility status of a resource. Read more about hidden records [here](https://docs.withterminal.com/guides/filtering).
    - `raw` object[]
      - `provider` string, required
      - `schema` string, required
      - `extractedAt` string, required
      - `data` object, required
  - `next` string, cursor — Cursor used for pagination.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests
- `500` — Internal Server Error
- `504` — Gateway Timeout Error

---

[API](https://skmtc.dev/withterminal/apis/terminal-telematics-api.md) · [All operations](https://skmtc.dev/withterminal/apis/terminal-telematics-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/withterminal/terminal-telematics-api/revisions/90249c4a1739/schema)