Access Codes

Search…

Access Codes

Key Codes to be programmed on a door lock.

The Access Code object
access_code_id
uuid
ID of the Access Code
code
string
Key Code to be entered on the lock
name
string
Name of the Access Code
status
string
unset: The time frame for an access code has not begun; the code is not set

setting: The code is being set

set: The code has been set

removing: The code is being removed

type
string
ongoing or time_bound
starts_at
datetime (ISO 8601)
Timestamp of when the Access Code begins (only relevant for time_bound codes)
ends_at
datetime (ISO 8601)
Timestamp of when the Access Code ends (only relevant for time_bound codes)
created_at
datetime (ISO 8601)
Timestamp of when the Access Code was created
​
An Ongoing Access Code will be active until it has been removed from the Device. Be sure to leave both the starts_at and ends_at fields empty to specify an ongoing Access Code.
A Time Bound Access Code will be programmed at the starts_attime, and removed at the ends_at time.
List of Methods
​Create an Access Code​
Create an Access Code
​Update an Access Code​
Update an Access Code
​Delete an Access Code​
Delete an Access Code
​Retrieve an Access Code​
Retrieve an Access Code
​Retrieve a list of Access Codes​
Retrieve a list of Access Codes

Update Device

Create an Access Code

Last modified 25d ago

Copy link

On this page

The Access Code object

List of Methods