Permissions
In order to use an endpoint or webhook, you’ll need to request the associated permissions from your user in Connect.
A permission is optional by default. This means that if you were to pass read_fuel in your Connect URL and the user tried to connect a Tesla, the permission would not show up as Tesla does not support fuel.
It can be made required by adding the required: prefix to the permission name, e.g. required:read_fuel. In this case, if a user were to try and connect a Tesla they’d see a No Compatible Vehicles Connect error as your
application is requiring vehicles to have the read_fuel permission.
In Europe, permissions can be conditional meaning that even if the required: prefix is provided, a vehicle can make it through Connect as we cannot be sure of a vehicle’s capability until you attempt to make an API request.
In this case you’ll receive a VEHICLE_NOT_CAPABLE API error. To read more about capabilities please see Compatibility by VIN.
Read
Permissions prefixed with read_ allow your application to get data from a vehicle as part of GET requests.
read_alerts | Read alerts from the vehicle |
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_security | Read the lock status of doors, windows, charging port, etc. |
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_user_profile | Read the information associated with a users connected services account profile such as their email and phone number. |
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_navigation | Send commands to the vehicle’s navigation system |
control_security | Lock or unlock the vehicle |
control_pin | Modify a PIN and enable the PIN to Drive feature for the vehicle. |
control_trunk | Open a vehicle’s trunk or frunk |