---
updatedAt: 2025-08-11T18:18:17.000Z
agentTools:
  projectIndex: https://docs.keycafe.com/llms.txt
---

# Key Object

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Field
      </th>

      <th style={{ textAlign: "left" }}>
        Type
      </th>

      <th style={{ textAlign: "left" }}>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        id
      </td>

      <td style={{ textAlign: "left" }}>
        integer: int64
      </td>

      <td style={{ textAlign: "left" }}>
        The unique identifier for the object.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        name
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        The key name.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        description
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        The key description.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        pickupNote
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        A note to send to the guest after a pickup.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        address
      </td>

      <td style={{ textAlign: "left" }}>
        object
      </td>

      <td style={{ textAlign: "left" }}>
        The location address.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        owner
      </td>

      <td style={{ textAlign: "left" }}>
        object
      </td>

      <td style={{ textAlign: "left" }}>
        The key owner.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        notes
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        The internal notes. These will not be displayed to the guest.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        serialNumber
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        The serial number of the fob attached to the key.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        homeLocation
      </td>

      <td style={{ textAlign: "left" }}>
        object
      </td>

      <td style={{ textAlign: "left" }}>
        The location where the key is expected to be dropped off or the most recent drop off location.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        currentLocation
      </td>

      <td style={{ textAlign: "left" }}>
        object
      </td>

      <td style={{ textAlign: "left" }}>
        The location where the key is currently stored. Present only if the key is currently checked in.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        currentUser
      </td>

      <td style={{ textAlign: "left" }}>
        object
      </td>

      <td style={{ textAlign: "left" }}>
        The user who picked up the key. Present only if the key is currently checked out.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        accesses
      </td>

      <td style={{ textAlign: "left" }}>
        collection
      </td>

      <td style={{ textAlign: "left" }}>
        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.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        virtual
      </td>

      <td style={{ textAlign: "left" }}>
        boolean
      </td>

      <td style={{ textAlign: "left" }}>
        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.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        code
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        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 <Anchor label="Key Code" target="_blank" href="https://support.keycafe.com/hc/en-us/articles/4409126750100-Key-Codes">Key Code</Anchor>.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        roaming
      </td>

      <td style={{ textAlign: "left" }}>
        boolean
      </td>

      <td style={{ textAlign: "left" }}>
        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.

        * <code>true</code>: Allows the key to be dropped off at any location.
        * <code>false</code>: Restricts drop-offs to the key’s home location only.
      </td>
    </tr>
  </tbody>
</Table>