Vehicle Endpoints
Lock Status
Vehicle Endpoints
Lock Status
Returns the lock status for a vehicle and the open status of its doors, windows, storage units, sunroof and charging port where available.
GET
/
vehicles
/
{id}
/
security
Permission
read_security
Request
Path
The vehicle ID of the vehicle you are making a request to.
Response
Indicates the current lock status of the vehicle as reported by the OEM.
An array of the open status of the vehicle’s doors.
An array of the open status of the vehicle’s windows.
An array of the open status of the vehicle’s sunroofs.
An array of the open status of the vehicle’s storages. For internal combustion and plug-in hybrid vehicles front refers to the engine hood. For battery vehicles, this will be the front trunk.
An array of the open status of the vehicle’s charging port.
Notes
- The open status array(s) will be empty if a vehicle has partial support.
- The request will error if
lockStatuscan not be retrieved from the vehicle or the brand is not supported.
Was this page helpful?