GET
/
v1.0.0
/
vehicles
/
{vehicleId}
/
refresh
{
  "lastUpdated": "2023-11-07T05:31:56Z",
  "chargeState": {
    "chargeRate": 6.5,
    "lastUpdated": "2023-11-07T05:31:56Z",
    "stateOfCharge": 72,
    "chargingTimeRemaining": 6,
    "chargeLimitMin": 20,
    "chargeLimitMax": 80,
    "scheduledDepartureTime": "2023-11-26T05:05:00Z",
    "scheduledChargingStartTime": "2023-11-26T05:00:00Z",
    "estimatedRange": 106,
    "chargingState": "CHARGING"
  },
  "odometer": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "odometer": 12228
  },
  "location": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "latitude": 50.770774,
    "longitude": -126.104965
  },
  "isOnline": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "climateState": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "isClimateOn": true,
    "isBatteryHeaterOn": true,
    "temperatureCurrent": 18,
    "temperatureTarget": 20
  },
  "userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9",
  "staticData": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "vendor": "TESLA",
    "name": "My Tesla",
    "engineType": "BEV",
    "vin": "1XKAD29X0KS502460",
    "model": "Model 3",
    "batteryCapacity": 60,
    "vehicleVariant": "Base"
  }
}

Authorizations

X-API-KEY
string
headerrequired

ApiKey used for authorization and authentication

Path Parameters

vehicleId
string
required

Vehicle ID

Response

200 - application/json

Object of vehicle response.

isOnline
boolean
required

Indicates if the vehicle is reachable trough the vendor system.

id
string
required

The ID of the vehicle.

userId
string
required

The ID of the user.

staticData
object
required

Object of static data of a vehicle.

lastUpdated
string

The timestamp of the last update of any field in the vehicle data.

chargeState
object

Object of charge state data of a vehicle.

odometer
object

Object of odometer data of a vehicle.

location
object

Object of location data of a vehicle.

climateState
object

Object of climate state of a vehicle.

All vehiclesDelete vehicle