queryGuests( )


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.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),in(),exists()
eventIdeq(),ne(),in(),exists()
rsvpIdeq(),ne(),in(),exists()
orderNumbereq(),ne(),in(),exists()
ticketNumbereq(),ne(),in(),exists()
ticketsexists()
contactIdeq(),ne(),in(),exists()
guestDetails.checkedIneq(),ne(),exists()
attendanceStatuseq(),ne(),in()
secondaryLanguageCodeeq(),ne(),in(),exists()
_createdDateeq(),ne(),lt(),le(),gt(),ge(),in(),exists(),ascending(),descending()
_updatedDateeq(),ne(),lt(),le(),gt(),ge(),in(),exists(),ascending(),descending()
attendanceStatusUpdatedDateeq(),ne(),lt(),le(),gt(),ge(),in(),exists(),ascending(),descending()
memberIdeq(),ne(),in(),exists()
guestTypeeq(),ne(),in()
Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Events - all permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
optionsQueryEventGuestsOptions
Returns
Return Type:GuestsQueryBuilder
Was this helpful?
Yes
No