Create a guest check in

Workforce module

POST/guest-check-insguestCheckIns.create

A door check-in of an approved guest with plus-ones admitted and the credential scanned. Creates a guest check in. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability credentials.scan.write.
OAuth scopes: credentials.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: GuestCheckInCreate

guestCheckIns.create: GuestCheckInCreate
Field	Type	Required	Description
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
door	string \| null	No	Door or gate.Constraints: length 1 to 80

{
  "guest_list_entry_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "plus_ones_admitted": 2,
  "door": "Gate A"
}

Response 201: GuestCheckIn

guestCheckIns.create: 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 POST "$XOS_BASE_URL/guest-check-ins" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"guest_list_entry_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","plus_ones_admitted":2,"door":"Gate A"}'

const { data } = await xos.guestCheckIns.create({
    "guest_list_entry_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "plus_ones_admitted": 2,
    "door": "Gate A"
  });

response = xos.guest_check_ins.create({"guest_list_entry_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "plus_ones_admitted": 2, "door": "Gate A"})

xos guest-check-ins create --data '{"guest_list_entry_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","plus_ones_admitted":2,"door":"Gate A"}'