Skip to main content
GET
Get a guest by ID

Authorizations

x-api-key
string
header
required

Path Parameters

_id
string
required

Guest ID to retrieve.

Query Parameters

event
string
required

Associated event ID.

Response

Guest details retrieved successfully.

_id
string
required

Guest ID

event
string
required

Event ID

status
object
required

Guest status information including confirmation, attendance, consents and check-in details

Example:
properties
object
required

Guest properties including default required fields and any custom properties defined for the event

Example:
_populated
object
required
confirmedAt
string<date-time> | null

Date and time when the guest was confirmed

attendedAt
string<date-time> | null

Date and time when the guest attended the event

starred
boolean
default:false

Indicates if the guest is starred

extras
object

Optional additional guest data

Example: