Retrieves a list of guests given the provided paging, filtering, and sorting. Query Event Guests runs with these defaults, which you can override:
createdDate
is sorted in ASC
orderpaging.limit
is 100
paging.offset
is 0
For field support for filters and sorting, see Event Guests: Supported Filters and Sorting.
To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.You can only call this method when authenticated as a Wix app or Wix user identity.
Query options. See API Query Language for more details.
Predefined sets of fields to return.
List of guests.
Metadata for the paginated results.
curl -X POST 'https://www.wixapis.com/events/v2/guests/query' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
--data-binary '{
"query": {
"filter": {
"guestType": "RSVP"
}
}
}'
{
"guests": [
{
"id": "ab249e78-edb0-4857-8b4b-d42b672ee764",
"eventId": "b189cf8b-a61f-443b-95bb-d9e88af0a277",
"rsvpId": "431321d0-f768-45c8-a390-9827c0107e0f",
"tickets": [],
"contactId": "023b6403-17e6-42dc-b475-a5ae6c2b8df4",
"attendanceStatus": "IN_WAITLIST",
"createdDate": "2023-01-10T13:22:23.302Z",
"updatedDate": "2023-01-10T13:22:23.302Z",
"attendanceStatusUpdatedDate": "2023-01-10T13:22:23Z",
"guestType": "RSVP"
}
],
"pagingMetadata": {
"count": 1,
"cursors": {}
}
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.