Guests
Manage the guest directory and their event assignments
Guests are the people who attend events. The directory is shared at the
organization level; events reference guests via eventGuests.
Resource overview
GET
/api/guestsAPI key · SessionPOST
/api/guestsAPI key · SessionGET
/api/guests/{id}API key · SessionPATCH
/api/guests/{id}API key · SessionDELETE
/api/guests/{id}API key · SessionList guests
GET
/api/guestsAPI key · Session| Name | Type | Required | Description |
|---|---|---|---|
page | integer | Optional | Page number. Default: 1 |
limit | integer | Optional | Page size. Default: 10 |
search | string | Optional | Substring match across name, email, phone. |
Create guest
POST
/api/guestsAPI key · Session| Name | Type | Required | Description |
|---|---|---|---|
name | string | Required | Guest name. |
email | string | Optional | Email address. |
phone | string | Optional | E.164 phone number, e.g. `+14155551234`. |
notes | string | Optional | Free-form notes (dietary, accessibility, etc.). |
Get / update / delete
GET
/api/guests/{id}API key · SessionPATCH
/api/guests/{id}API key · SessionDELETE
/api/guests/{id}API key · SessionTo attach a guest to an event, see
POST /api/events/{id}/guests.