Door list

Workforce module

GET/guest-check-ins/door-listguestCheckIns.doorList

Approved and checked-in guests of a project for door staff, filtered by name. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability credentials.scan.write.
OAuth scopes: credentials.
Error statuses: 400, 401, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

guestCheckIns.doorList: Path and query parameters
Field	Type	Required	Description
project_id	string (uuid)	Yes	Project.
q	string	No	Name contains this.Constraints: length 0 to 200

Response 200: DoorGuestPage

guestCheckIns.doorList: DoorGuestPage
Field	Type	Required	Description
data	array of DoorGuest	Yes	Items on this page, in the documented default order.
next_cursor	string \| null	Yes	Opaque cursor for the next page; null on the last page.

{
  "data": [
    {
      "guest_list_entry_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "guest_name": "Jordan Ellis",
      "plus_ones": 2,
      "entry_state": "Approved",
      "note": "Side stage.",
      "checked_in_at": "2026-10-08T14:30:00Z",
      "plus_ones_admitted": 2,
      "door": "Gate A"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/guest-check-ins/door-list" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data } = await xos.guestCheckIns.doorList();

response = xos.guest_check_ins.door_list()

xos guest-check-ins door-list