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

# Access Object

| Field                      | Type           | Description                                                                                                                                                     |
| -------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                         | integer: int64 | The unique identifier for the object.                                                                                                                           |
| bookingCode                | string         | A unique code used by a guest to pick up or drop off keys at a SmartBox or to link access during account registration or in the app's "Link an Access" section. |
| checkinLink                | string         | A URL for guests providing 24/7 support and a guided mobile experience for actions like pickup or drop-off. Returned only for scheduled accesses.               |
| accessStartDate            | string         | The access start date (e.g., 2025-04-21).                                                                                                                       |
| accessStartTime            | string         | The access start time (e.g., 12:45).                                                                                                                            |
| accessEndDate              | string         | The access end date (e.g., 2025-04-25).                                                                                                                         |
| accessEndTime              | string         | The access end time (e.g., 12:45).                                                                                                                              |
| timeZone                   | string         | The access time zone (e.g., America/Vancouver).                                                                                                                 |
| returnReminder             | boolean        | Whether the guest should receive a reminder to return the key after their visit.                                                                                |
| allowSetup                 | boolean        | If true, allows the access recipient to attach a fob to the key.                                                                                                |
| suppressGuestNotifications | boolean        | If true, no notifications related to this access will be sent to the guest.                                                                                     |
| name                       | string         | The visitor's name.                                                                                                                                             |
| user                       | object         | The user who has been granted access.                                                                                                                           |
| key                        | object         | The key(s) for which access has been granted.                                                                                                                   |
| locale                     | string         | The locale used for sending guest notifications.                                                                                                                |
| accessCode                 | string         | **DEPRECATED** – A code once used to access keys. Use `bookingCode` instead as it is now access-level unique.                                                   |
| linkCode                   | string         | **DEPRECATED** – Used by guests to claim access during registration. Returned only for scheduled accesses.                                                      |
| startDate                  | date-time      | **DEPRECATED** – ISO 8601 formatted start date. Returned only for scheduled accesses.                                                                           |
| endDate                    | date-time      | **DEPRECATED** – ISO 8601 formatted end date. Returned only for scheduled accesses.                                                                             |