Key Object

FieldTypeDescription
idinteger: int64The unique identifier for the object.
namestringThe key name.
descriptionstringThe key description.
pickupNotestringA note to send to the guest after a pickup.
addressobjectThe location address.
ownerobjectThe key owner.
notesstringThe internal notes. These will not be displayed to the guest.
serialNumberstringThe serial number of the fob attached to the key.
homeLocationobjectThe location where the key is expected to be dropped off or the most recent drop off location.
currentLocationobjectThe location where the key is currently stored. Present only if the key is currently checked in.
currentUserobjectThe user who picked up the key. Present only if the key is currently checked out.
accessescollectionA list of active accesses. Indicates the nature of the logged-in user's access to the key. If omitted, the key is owned by the user.
virtualbooleanWhen true, the key does not require linkage with a physical Keycafe fob. A virtual fob will be automatically assigned and can be used with key codes.
codestringA 4 to 16 digit numeric code allowing instant pickups for virtual keys when entered locally at the Keycafe SmartBox. Requires "Key Codes" to be enabled in advanced settings. For more information, refer to Key Code.
roamingbooleanDetermines whether the key can be dropped off at any location or only at its designated home location. Applies only to MS4 and newer devices.
  • true: Allows the key to be dropped off at any location.
  • false: Restricts drop-offs to the key’s home location only.