Introduction
With the Event Guests API, site owners can get information about all guests who bought tickets to an event or who RSVP'ed. The information includes guest names, email addresses, tickets, RSVP status, and so on. This makes it easier to build custom functionality around event management, such as sending custom notifications to guests, managing event capacity, and generating reports on attendance.
The Event Guests API allows you to:
- Retrieve a list of guests by event ID.
- Get information about each individual ticket buyer.
- Find out the attendance status of each guest.
Terminology
- Guest: The individual who has been invited to the event.
- RSVP: A response from the guest indicating whether they plan to attend the event.
- Ticket buyer: The individual who bought 1 or more tickets to the event.
- Check-in: The process of verifying a guest's attendance at the event.
- Guest list: A summary of all guests who have been invited to the event.
- Organizer: The person or entity responsible for planning and hosting the event.
Setup
To use the Guests API, install the @wix/events package using npm or Yarn:
1npm install @wix/events
or
1yarn add @wix/events
Then import { guests } from @wix/events:
1import { guests } from '@wix/events'
Creates a query to retrieve a list of guests.
The queryGuests() function builds a query to retrieve a list of guests and returns a GuestsQueryBuilder object.
The returned object contains the query definition which is typically used to run the query using the find() function.
You can refine the query by chaining GuestsQueryBuilder functions onto the query. GuestsQueryBuilder functions enable you to sort, filter, and control the results that queryGuests.find() returns.
The query runs with the following GuestsQueryBuilder defaults that you can override:
The functions that are chained to queryGuests() are applied in the order they are called. For example, if you apply ascending ('_createdDate') and then descending ('_updatedDate'), the results are sorted first by the created date and then, if there are multiple results with the same date, the items are sorted by the updated date.
The table below shows which GuestsQueryBuilder functions are supported for queryGuests(). You can only use one filter function for each property. Only the first filter will work if a property is used in more than one filter.
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
_id | eq(),ne(),in(),exists() |
eventId | eq(),ne(),in(),exists() |
rsvpId | eq(),ne(),in(),exists() |
orderNumber | eq(),ne(),in(),exists() |
ticketNumber | eq(),ne(),in(),exists() |
tickets | exists() |
contactId | eq(),ne(),in(),exists() |
guestDetails.checkedIn | eq(),ne(),exists() |
attendanceStatus | eq(),ne(),in() |
secondaryLanguageCode | eq(),ne(),in(),exists() |
_createdDate | eq(),ne(),lt(),le(),gt(),ge(),in(),exists(),ascending(),descending() |
_updatedDate | eq(),ne(),lt(),le(),gt(),ge(),in(),exists(),ascending(),descending() |
attendanceStatusUpdatedDate | eq(),ne(),lt(),le(),gt(),ge(),in(),exists(),ascending(),descending() |
memberId | eq(),ne(),in(),exists() |
guestType | eq(),ne(),in() |
Permission Scopes
For app development, you must have one of the following permission scopes:function queryGuests(options: QueryEventGuestsOptions): GuestsQueryBuilder