get https://api.butterflymx.com/v4/keychains
Keychains and Virtual Keys provide a mechanism for people to
grant temporary access to a building, unit, access points or
key lockers.
A Keychain is the configuration object for one or more
Virtual Keys. It holds the duration, owner, and other
information about the Virtual Keys attached to it. While the Virtual
Keys contain the recipient information and usage statistics.
There are multiple types of Keychains available that provide different
access scheduling mechanisms for the Virtual Keys attached to them.
- Custom keychains grant access from a given start time and date,
to an end time and date. - Recurring keychains grant access on a recurring schedule,
specified by a list of weekdays on which the key is active, a start
and an end time. Additionally a start and end date must be specified. - One Time keychains are alike custom keychains but grant the
recipient access only once. After the key is used it can be re-used
for an additional 15min after which it expires. - Delivery Pass keychains are alike one time keychains but have
a much shorter grace period of 5min after the key is used. And they
always hold exactly one Virtual Key. Not much can be specified or
updated on them. Their main purpose is to provide a quick way to
generate a virtual key and share it with a delivery person.