<!-- https://unlockos.io/manual/checkin-list -->

# Check-in List Help

## Overview

Check-in List manages your created check-in configurations. Each configuration functions as a "check-in point" combining plans, smart locks, and payment conditions.

![Check-in List screen](https://unlockos.io/help/images/checkin-list/main.en.webp)

## Key Features

- View list of check-in configurations (two tabs: "Starts a stay" and "In-house services")
- Create, edit, and delete configurations
- Copy configuration ID (for external integration)
- Copy the check-in URL and embed snippet

---

## Display Fields

| Field | Description |
|-------|-------------|
| Configuration Name | Display name of the check-in configuration |
| Check-in ID | Internal system ID (used for URL generation and API integration) |
| Plan / Plan Group | Associated pricing plan or group |
| Entrance Key | Unit ID of the entry smart lock |
| Exit Key | Unit ID of the exit smart lock |
| Payment | Payment timing (Postpaid/Prepaid/Prepaid+Postpaid/No Payment) |
| Currency | Currency used |
| Deposit | Deposit amount (if configured) |
| Prepaid Display | Prepaid display amount (if different from deposit) |

Configurations in the "In-house services" tab also show two more badges.

| Badge | Meaning |
|-------|---------|
| Listed / Not listed | Whether it appears in the guest's "Available during your stay" list |
| Anyone / Stay only | Whether it's restricted to guests with an active stay |

These are toggled on each configuration's edit screen (the "How This Appears as an In-House Service" section). See [Check-in Configuration help](checkin-config-form.md) for details.

---

## Tabs: Starts a Stay / In-House Services

The list is split into two tabs — "Starts a stay (N)" and "In-house services (N)". The number in parentheses is the count of configurations in that tab.

| Tab | Contains |
|-----|----------|
| Starts a stay | Entrances that begin the stay itself — accommodation check-in, walk-in, and so on |
| In-house services | Facilities guests use during their stay — a bathhouse, meeting room, laundry, and so on. This order becomes the order guests see in "Available during your stay" |

Which tab a configuration falls into is decided on its edit screen, under "How This Appears as an In-House Service" (the default is "Starts a stay").

- **"Create New" carries over the role of the tab you have open.** Creating a configuration while the "In-house services" tab is open makes it an in-house service from the start; the "Starts a stay" tab creates an ordinary entrance (you can always change the role later from the edit screen)
- A tab with no configurations shows a tab-specific message
- Reordering (drag-and-drop or ↑/↓ buttons) stays within the tab you're viewing — order never swaps across the two tabs

---

## Buttons

| Button | Description |
|--------|-------------|
| Create New | Create a new check-in configuration |
| Edit | Edit an existing configuration |
| Delete | Delete the configuration |

### What happens after saving

Saving a new or edited check-in configuration does not show a confirmation modal — you're taken straight back to this list. A toast at the top of the screen reads "Check-in configuration saved!" A configuration created or edited from the "In-house services" tab returns you to that same tab.

The check-in URL and embed snippet are never shown in a modal — copy them anytime from **each row in the list** (see "Using Check-in ID" below).

### Reordering

Drag the handle on the left of a row, or use the ↑ / ↓ buttons, to reorder check-in configurations. The order is saved and shared with other administrators. On the "Starts a stay" tab, the order only affects the admin list, not the check-in screen guests open. On the "In-house services" tab, the order is the order in which guests see the in-stay services. Reordering stays within the tab you're viewing.

---

## Using Check-in ID

Check-in ID is used in the following scenarios:

1. **Check-in URL Generation**: Required when generating check-in URLs in `Unlock Lab`
2. **API Integration**: Parameter when calling UnlockOS API from external systems
3. **Embedded Snippet**: Used when embedding check-in functionality on your site

The check-in ID itself is shown as plain text on each row (select it to copy). If all you need is a ready-to-use check-in URL or embed snippet, you don't need to note the ID down at all — each row's "Copy URL" and "Copy Snippet" buttons give you one with that ID already built in.

---

## Auto-Checkout

Check-in configurations using any plan type have auto-checkout built in automatically. When the plan's usage period ends, guests are automatically checked out.

- Auto-checkout timing is determined by the plan type
- No additional setup is required
- Guest keys are automatically revoked at checkout

For details, see the "Auto-Checkout" section in the Check-in History help page.

---

## FAQ

### Q: Can I create multiple check-in configurations for the same plan?
A: Yes. This is useful when you have different entrances or different payment conditions.

### Q: Does deleting a check-in configuration delete the check-in history?
A: No, past check-in history is retained. However, you can no longer check in using the deleted configuration.

### Q: Can I temporarily disable a configuration?
A: Currently, there is no feature to toggle configurations on/off. Please delete if no longer needed.

### Q: I saved a configuration but no screen showed me a check-in URL or QR code

A: That's expected after a recent change. A confirmation modal used to show the URL and snippet right after saving, but it has been removed — saving now takes you straight back to the list. You can copy the URL or snippet anytime from the "Copy URL" and "Copy Snippet" buttons on each row.

### Q: A configuration I created doesn't show up in the "Starts a stay" tab

A: Its role is probably set to "In-house services" — check that tab instead. You can change the role anytime from the configuration's edit screen, under "How This Appears as an In-House Service."

---

## Related Pages

- Check-in Configuration (Create/Edit)
- Plan List
- Unlock Lab (URL/Snippet Generation)
- Check-in History
