Introduction
Permissions
In order to use an endpoint or webhook, you'll need to request the associated permissions from your user in Connect.
Read
Permissions prefixed with read_
allow your application to get data from a vehicle as part of GET
requests
or event based webhooks.
read_battery | Read an EV’s high voltage battery data |
read_charge | Read charging data |
read_charge_locations | Access previous charging locations and their associated charging configurations |
read_charge_records | Read charge records and associated billing information |
read_charge_events | Receive notifications for events associate with charging |
read_climate | Read the status and settings of the vehicle’s climate control system |
read_compass | Read the compass direction the vehicle is facing |
read_engine_oil | Read vehicle engine oil health |
read_extended_vehicle_info | Read vehicle configuration information from a vehicle |
read_fuel | Read fuel tank level |
read_location | Access the vehicles location |
read_odometer | Retrieve total distance traveled |
read_speedometer | Read a vehicle’s speed |
read_thermometer | Read temperatures from inside and outside the vehicle |
read_tires | Read a vehicle’s tire status |
read_vehicle_info | Know make, model, and year |
read_vin | Read VIN |
Control
Permissions prefixed with control_
allow your application to issue commands or apply settings
to a vehicle as part of POST
or PUT
requests.
control_charge | Control a vehicle’s charge state |
control_climate | Set the status and settings of the vehicle’s climate control system |
control_security | Lock or unlock the vehicle |
Required Permissions
The required:
prefix allows you to filter out vehicles on the Connect grant screen that do not support it e.g.
passing required:read_fuel
would lead to a no_compatible_vehicles
error in Connect for Tesla as it’s an
EV and cannot support fuel endpoints.