The Event Guests API allows you to retrieve information about all guests who bought tickets to an event or who RSVP'ed. This can be particularly useful for event organizers who need to manage large numbers of attendees or who want to integrate their event management system with other software tools. Additionally, with the Event Guests API you can create custom applications that leverage event guest data, such as mobile event apps or marketing automation systems.
The Event Guests API allows you to:
It’s important to note the following points before starting to code:
guestDetailsfieldset is sent in the request.
The following table shows field support for filters and sorting for the Event Guest object:
|Field||Query Filter Operators||Sortable|
Related content: ,
This article shares some possible use cases your app could support, as well as a sample flow that could support each use case. This can be a helpful jumping off point as you plan your app's implementation.
A lot of users aim to re-engage attendees who have previously participated in similar events or activities. With your app, you can retrieve the guest list from a past event and create a targeted email campaign that includes details about the upcoming event. The invitation can be tailored based on the past attendance history (see ) or preferences of guests. This use case can be an effective way to increase attendance at future events, and generate more interest in them.
Note: This flow assumes your guests already have the ability to subscribe to your newsletters.
To send invitations about an upcoming event, follow these steps:
eventId. by past
Retrieve all the email addresses from the
guestDetails object, and write your code so that they can be passed to your marketing tool.
Request and filter the list of subscribers in your external marketing tool by the retrieved emails.
Filter the list once again by the subscription status.
The contacts who have opted-in to marketing emails is now ready to receive the invitations.
An analytics system can provide valuable insights into guest attendance at events, making it easier to track and analyze data on attendance patterns, behavior, and preferences. For example, you can use your app to periodically check attendance for your events to determine which events often have no-shows. This information could help you determine if certain events need more advertising, reminders, or a change to pricing (for example, people are more likely to attend if they have paid, even a small amount, to attend).
To get attendance analytics, follow these steps:
eventId. of each past event, filtering by
For each event and each of its guests, retrieve the
guestDetails.checkedIn value, and ensure that your code is capable of passing it to your analytics tool.
In your analytics tool, calculate for each event how many
guestDetails.checkedIn values are
false and compute the attendance ratio.
Retrieves a list of guests given the provided paging, filtering, and sorting. Query Event Guests runs with these defaults, which you can override:
createdDateis sorted in
0For field support for filters and sorting, see . To learn about working with Query endpoints, see , , and .
Triggered when a guest is created.
Triggered when a guest is deleted.