POST

Query Rsvps


Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves a list of RSVPs, with the specified paging, filtering, and sorting.

Query RSVPs runs with these defaults, which you can override:

  • createdDate is sorted in ASC order.
  • paging.limit is 100.
  • paging.offset is 0.

By default, each RSVP includes only basic fields such as id, eventId, contactId and status. To read check-in status, pass fields: ["DETAILS"], which requires the WIX_EVENTS.READ_RSVP_DETAILS permission. The response then includes:

  • guestList.guests[].checkInDetails.checkedIn and checkInDate: Check-in status of each guest.
  • fullyCheckedIn: Whether all of the RSVP's guests are checked in. An RSVP with additional guests is false until every guest is checked in.
  • checkedInGuestCount: Number of checked-in guests.

To check whether a specific guest is checked in, call Get RSVP with the RSVP ID and fields: ["DETAILS"], find the guest in guestList.guests by guestId, and read checkInDetails.checkedIn. A contact can have more than one RSVP for an event, so don't identify an RSVP by eventId and contactId alone. You can filter by fullyCheckedIn without requesting DETAILS.

To learn about working with Query methods, see API Query Language, Sorting and Paging, and Field Projection.

Note: This method is quite slow. Use the following filter pairs for the most optimal speed:

  • eventId and status
  • eventId and fullyCheckedIn
  • eventId and memberId
  • eventId and contactId
  • eventId and createdDate
PropertyFiltersSort
_id$eq, $ne, $in, $nin, $existsNone
eventId$eq, $ne, $in, $nin, $existsNone
memberId$eq, $ne, $in, $nin, $existsNone
contactId$eq, $ne, $in, $nin, $existsNone
status$eq, $ne, $in, $ninSort: ASC, DESC
fullyCheckedIn$eq, $ne, $in, $ninSort: ASC, DESC
_updatedDate$eq, $ne, $in, $nin, $gt, $gte, $lt, $lteSort: ASC, DESC
_createdDate$eq, $ne, $in, $nin, $gt, $gte, $lt, $lteSort: ASC, DESC
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permission Scopes
Read Event Tickets and Guest List
Learn more about app permissions.
Method Declaration
Copy
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?