Get a guest check in
Workforce module
GET/guest-check-ins/{id}guestCheckIns.get
A door check-in of an approved guest with plus-ones admitted and the credential scanned. Returns one guest check in with its `ETag`. A guest check in the caller may not see returns 404.
- Requires the capability credentials.scan.write.
- OAuth scopes: credentials.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the guest check in. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: GuestCheckIn
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the guest check in. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| guest_list_entry_id | string (uuid) | Yes | Identifier of the guest list entry. |
| plus_ones_admitted | integer | Yes | Plus-ones admitted.Constraints: range 0 to any |
| credential_id | string (uuid) | null | Yes | Identifier of the credential scanned. |
| door | string | null | Yes | Door or gate.Constraints: length 1 to 80 |
| checked_in_by_membership_id | string (uuid) | null | Yes | Identifier of the door staff member. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"guest_list_entry_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"plus_ones_admitted": 2,
"credential_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"door": "Gate A",
"checked_in_by_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X GET "$XOS_BASE_URL/guest-check-ins/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.guestCheckIns.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.guest_check_ins.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos guest-check-ins get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f