Skip to main content
GET
/
v1
/
vehicles
/
{vehicle_id}
/
alerts
Get Vehicle Alerts
curl --request GET \
  --url https://api.volteras.com/v1/vehicles/{vehicle_id}/alerts \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "<string>",
      "alertDefinitionId": "<string>",
      "vehicleId": "<string>",
      "muted": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "resolutions": [
        {
          "id": "<string>",
          "definition": {
            "id": "<string>",
            "name": "<string>",
            "description": "<string>"
          },
          "steps": [
            {
              "id": "<string>",
              "definition": {
                "id": "<string>",
                "description": "<string>",
                "order": 123
              }
            }
          ]
        }
      ],
      "definition": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "message": "<string>",
        "category": {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>"
        }
      },
      "metadata": {
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "vin": "<string>",
      "triggerName": "<string>",
      "triggerDescription": "<string>"
    }
  ],
  "nextPageToken": "<string>",
  "totalResults": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.volteras.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Path Parameters

vehicle_id
string
required

Unique internal identifier for the vehicle.

Query Parameters

maxPageSize
integer

Max size of the returned list.

pageToken
string | null

Page token used for pagination.

filter
string | null

Listing filter schema.

Response

200 - application/json

Successful Response

results
VehicleAlertResponse · object[]
required

Returned data from the listing query.

nextPageToken
string | null
required

Next page token used for pagination.

totalResults
integer
required

Total result count.