Lock

Represents a Lock on the UniKey CORE Platform, such as a User’s Kwikset Kevo. Locks have an available Bolt State (locked, unlocked) as well as online status. A Lock will appear online if the User has a valid key to the Lock and the Lock is connected to a supported Gateway, such as a Kevo Plus.

The Lock object

Attributes
Name Type Description
id UUID The ID of the Lock
name String The name of the Lock created by the User
bolt_state String The current Bolt State (if available)
online_status String The Lock’s current online status
Lock Bolt States
Name Description
unknown The current Bolt State is unknown
locked The Lock is locked
unlocked The Lock is unlocked
Lock Online Statuses
Name Description
online The Lock is online and available for remote control
offline The Lock is offline

Available APIs

GET /lock/{lock_id}

Returns information about a given Lock

Request Properties
Name Type Description
lock_id UUID Required The ID of the desired Lock
Response Properties

Returns a Lock object

Example Request
GET /lock/4e269466-e6b1-4e34-8e0e-d74f3fd65688/
Example Response
HTTP/1.1 200 OK

{
    "id": "4e269466-e6b1-4e34-8e0e-d74f3fd65688",
    "name": "Home - Front Door",
    "online_status": "online",
    "bolt_state": "locked"
}