Key Object

Field

Type

Description

id

integer: int64

The unique identifier for the object.

name

string

The key name.

description

string

The key description.

pickupNote

string

A note to send to the guest after a pickup.

address

object

The location address.

owner

object

The key owner.

notes

string

The internal notes. These will not be displayed to the guest.

serialNumber

string

The serial number of the fob attached to the key.

homeLocation

object

The location where the key is expected to be dropped off or the most recent drop off location.

currentLocation

object

The location where the key is currently stored. Present only if the key is currently checked in.

currentUser

object

The user who picked up the key. Present only if the key is currently checked out.

accesses

collection

A 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.

virtual

boolean

When 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.

code

string

A 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.

roaming

boolean

Determines 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.