List Vehicles

curl --request GET \
  --url https://api.volteras.com/v1/vehicles \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "make": "<string>",
      "vin": "<string>",
      "id": "<string>",
      "metadata": {
        "lastSeenAt": "2023-11-07T05:31:56Z",
        "consentId": "<string>",
        "accountId": "<string>"
      },
      "model": "<string>",
      "trim": "<string>",
      "modelYear": "<string>",
      "registrationPlate": "<string>",
      "isRegNoValidated": true,
      "regNoValidatedAt": "2023-11-07T05:31:56Z",
      "isListening": true,
      "listeningLastUpdated": "2023-11-07T05:31:56Z"
    }
  ],
  "nextPageToken": "<string>",
  "totalResults": 123
}

Vehicles

List Vehicles

Retrieve a paginated list of vehicles associated with your organization.

The endpoint lists vehicles based on the following criteria:

Includes only vehicles that have enabled synchronization during the account connection process.
Excludes disconnected vehicles or those not included in the OEM account.

Returns:

A paginated response containing a list of vehicles.

Note:

This endpoint provides a summary of each vehicle’s basic details. For comprehensive vehicle data, please refer to the individual vehicle detail endpoints.

Find details on list filter syntax in our documentation here.

Possible Codes in Error Response (see Errors for error response schema and meaning of codes):

AUTHENTICATION_ERROR
PAGE_SIZE_TOO_LARGE
PAGINATED_QUERY_FILTER_CHANGED
REQUEST_VALIDATION_ERROR
SERVER_ERROR

GET

vehicles

List Vehicles

curl --request GET \
  --url https://api.volteras.com/v1/vehicles \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "make": "<string>",
      "vin": "<string>",
      "id": "<string>",
      "metadata": {
        "lastSeenAt": "2023-11-07T05:31:56Z",
        "consentId": "<string>",
        "accountId": "<string>"
      },
      "model": "<string>",
      "trim": "<string>",
      "modelYear": "<string>",
      "registrationPlate": "<string>",
      "isRegNoValidated": true,
      "regNoValidatedAt": "2023-11-07T05:31:56Z",
      "isListening": true,
      "listeningLastUpdated": "2023-11-07T05:31:56Z"
    }
  ],
  "nextPageToken": "<string>",
  "totalResults": 123
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

maxPageSize

integer

Max size of the returned list.

pageToken

string | null

Page token used for pagination.

filter

string | null

Listing filter schema.

tagKey

string | null

tagValue

string | null

Response

200 - application/json

Successful Response

results

Vehicle · object[]

required

Returned data from the listing query.

Show child attributes

results.make

string

required

Manufacturer of the vehicle.

results.vin

string

required

Vehicle identification number. Unique identifier for the vehicle.

results.id

string

required

Unique internal identifier for the vehicle.

results.metadata

VehicleMetaData · object

required

Additional information about the vehicle.

Show child attributes

results.metadata.lastSeenAt

string<date-time> | null

required

The last recorded interaction with the vehicle endpoints. This is a timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

Unique identifier for the consent that was used to retrieve the vehicle data.

results.metadata.accountId

string | null

required

Unique identifier for the account that was used to retrieve the vehicle data.

results.model

string | null

Subcategory of the make, used to differentiate between different variations of a vehicle within the same make.

results.trim

string | null

Subcategory of the model, used to differentiate between different variations of a vehicle within the same model. Also referred to as version or generation.

results.modelYear

string | null

Year the vehicle model was released. Could be different than the year the vehicle was manufactured.

results.registrationPlate

string | null

Plate that is attached to a vehicle and displays a unique combination of letters and numbers assigned to the vehicle by a government agency. Also referred to as license plate or registration number.

results.isRegNoValidated

boolean | null

Indicates whether the registration plate has been validated

results.regNoValidatedAt

string<date-time> | null

Timestamp of when the registration plate was last validated

results.isListening

boolean

default:true

Indicates whether the vehicle is currently accepting data ingestion and commands. Defaults to True when no listening state entries have been recorded.

results.listeningLastUpdated

string<date-time> | null

UTC timestamp for the most recent listening-state update, or null when no entries exist.

nextPageToken

string | null

required

Next page token used for pagination.

totalResults

integer

required

Total result count.

Action Disconnect Upload Vehicle

⌘I

Authentication

Accounts

Vehicles

Vehicle Telemetry

Vehicle Charging History

Vehicle Range

Vehicle State of Health

Vehicle Command Executions

Vehicle Alerts

Errors

Vehicle Connection

Vehicle Services

Vehicle Tires

Vehicle Manufacturer Alerts

Vehicle Eligibility

Rate Limit

Vehicle Charging Schedule

Vehicle Listening

Tags

List Vehicles

Authorizations

Query Parameters

Response