Access Object


id integer: int64	The unique identifier for the object.
bookingCode string	A code that is unique to a given access, which can be used by a guest to pick up or drop off keys at a SmartBox or link the access to a Keycafe account (during registration or in the "More - Link an Access" section of the app).
checkinLink string	A URL that is unique to a given access and provides the guest with 24/7 support and a step-by-step mobile experience for completing all steps related to the access (such as picking up or dropping off a key, etc.). Returned only for scheduled accesses.
accessStartDate string	The access start date (ex: 2018-07-21).
accessStartTime string	The access start time (ex: 12:45).
accessEndDate string	The access end date (ex: 2018-07-23).
accessEndTime string	The access end time (ex: 12:45).
timeZone string	The access time zone (ex: America/Vancouver).
returnReminder boolean	Whether the guest should be sent a reminder to return the key after their visit.
allowSetup boolean	If true, the access recipient will be able to attach a fob to the key.
suppressGuestNotifications boolean	If true, prevents any access notifications from being sent to the guest.
name string	The visitor's name.
user object	The user who has been given access.
key object	The keys for which access has been given.
locale string	The locale used to send notifications to the guest.
accessCode string `DEPRECATED`	A code used by the guest to access their keys. The access code is unique at the user-level, whereas the booking code is now unique at the access-level, and should be used instead.
linkCode string `DEPRECATED`	A code used by a guest during registration (or in the "More - Link an Access" section of the app) to claim an access for their account. Returned only for scheduled accesses.
startDate date-time `DEPRECATED`	See the Date Formats section for detailed information. The start date of the access, in ISO 8601 format without milliseconds. Returned only for scheduled accesses.
endDate date-time `DEPRECATED`	See the Date Formats section for detailed information. The end date of the access, in ISO 8601 format without milliseconds. Returned only for scheduled accesses.