Get a guest list entry

Módulo Advancing

GET/guest-list-entries/{id}guestListEntries.get

A guest on a project's guest list with plus-ones. Requested guests are approved or declined by someone with review authority who did not request them, then checked in at the door. Returns one guest list entry with its `ETag`. A guest list entry the caller may not see returns 404.

Requiere la capacidad advancing.packet.read.
Alcances de OAuth: advancing.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

guestListEntries.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the guest list entry.
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

Respuesta 200: GuestListEntry

guestListEntries.get: GuestListEntry
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the guest list entry.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row.
project_id	string (uuid)	Sí	Identifier of the project.
scope_node_id	string (uuid) \| null	Sí	Identifier of the show or other scope node of the same project.
person_id	string (uuid) \| null	Sí	Identifier of the person whose list the guest is on.
counterparty_id	string (uuid) \| null	Sí	Identifier of the organization whose list the guest is on.
engagement_id	string (uuid) \| null	Sí	Identifier of the engagement the guest was requested under in Gateway.
guest_name	string	Sí	Name the guest gives at the door.Restricciones: length 1 to 200
plus_ones	integer	Sí	Additional guests admitted with this guest, 0 to 20.Restricciones: range 0 to any
note	string \| null	Sí	Notes for the door.Restricciones: length 1 to 500
entry_state	"Requested" \| "Approved" \| "Declined" \| "Checked In"	Sí	Requested, Approved, Declined or Checked In; moved by the decide and check-in actions.
decided_at	string (date-time) \| null	Sí	When the request was approved or declined. Set by the database.
decided_by	string (uuid) \| null	Sí	Identifier of the person who decided, set by the database.
checked_in_at	string (date-time) \| null	Sí	When the guest was checked in. Set by the database.
checked_in_by	string (uuid) \| null	Sí	Identifier of the person who checked the guest in, set by the database.

{
  "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",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "guest_name": "Jordan Pike",
  "plus_ones": 1,
  "note": "Side stage.",
  "entry_state": "Requested",
  "decided_at": "2026-10-08T14:30:00Z",
  "decided_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "checked_in_at": "2026-10-08T14:30:00Z",
  "checked_in_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/guest-list-entries/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.guestListEntries.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.guest_list_entries.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos guest-list-entries get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f