> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # QueryRsvps # Package: registration # Namespace: RsvpManagement # Method link: https://dev.wix.com/docs/api-reference/business-solutions/events/registration/rsvp-v2/query-rsvps.md ## Permission Scopes: Read Event Tickets and Guest List: SCOPE.DC-EVENTS.READ-GUEST-LIST ## Introduction 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`. To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language.md), [Sorting and Paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging.md), and [Field Projection](https://dev.wix.com/docs/rest/articles/get-started/field-projection.md). > **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` --- ## REST API ### Schema ``` Method: queryRsvps Description: 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`. To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language.md), [Sorting and Paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging.md), and [Field Projection](https://dev.wix.com/docs/rest/articles/get-started/field-projection.md). > **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` URL: https://www.wixapis.com/events/v2/rsvps/query Method: POST Method parameters: param name: fields | type: array | description: Predefined sets of fields to return. - enum: - DETAILS: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`. - FORM: Returns `form`. - CONTACT_DETAILS: Returns `email`. param name: query | type: CursorQuery - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` - name: sort | type: array | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: - ASC: Sort is in the ascending order. - DESC: Sort is in the descending order. Return type: QueryRsvpsResponse - name: rsvps | type: array | description: Retrieved RSVPs. - name: id | type: string | description: GUID of the RSVP. - name: revision | type: string | description: Revision number, which increments by 1 each time the RSVP is updated. To prevent conflicting changes, the existing `revision` must be used when updating the RSVP. - name: eventId | type: string | description: Event GUID to which the RSVP belongs. - name: createdDate | type: string | description: Date and time the RSVP was created. - name: updatedDate | type: string | description: Date and time the RSVP was updated. - name: memberId | type: string | description: Site member GUID. - name: contactId | type: string | description: Contact GUID of a guest who filled in the RSVP form. See the Contacts API for more details. - name: firstName | type: string | description: First name of a guest who filled in the RSVP form. - name: lastName | type: string | description: Last name of a guest who filled in the RSVP form. - name: email | type: string | description: Email of a guest who filled in the RSVP form. - name: form | type: FormResponse | description: Event registration form. - name: inputValues | type: array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: array | description: Form field values. - name: status | type: RsvpStatus | description: RSVP response status. - enum: - YES: Guest is attending the event. - NO: Guest isn't attending the event. - WAITLIST: Guest is on a waitlist. - name: totalGuests | type: integer | description: Total number of guests per 1 RSVP. - name: guestList | type: GuestList | description: Guest list. - name: guests | type: array | description: List of guests. - name: index | type: integer | description: Index of each guest in the array. - name: fullName | type: string | description: Full name. - name: checkInDetails | type: CheckInDetails | description: Check-in details. - name: checkedIn | type: boolean | description: Whether the guest has checked in. - name: checkInDate | type: string | description: Date and time the guest checked in. - name: checkInCanceledDate | type: string | description: Date and time the guest cancelled check-in. - name: checkedInBy | type: string | description: Id of the user who last performed check-in - name: checkInCanceledBy | type: string | description: Id of the user who last canceled check-in - name: checkedInByStaffMember | type: string | description: Id of the Staff Member who last performed check-in - name: checkInCanceledByStaffMember | type: string | description: Id of theStaff Member who last canceled check-in - name: guestId | type: integer | description: Guest GUID. - name: language | type: string | description: 2-letter language code in the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. - name: locale | type: string | description: Locale in the [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. - name: fullyCheckedIn | type: boolean | description: Whether all guests are checked in. - name: checkedInGuestCount | type: integer | description: Number of checked in guests. - name: additionalGuestDetails | type: AdditionalGuestDetails | description: Additional guest details. - name: guestCount | type: integer | description: Number of additional guests. - name: guestNames | type: array | description: Names of additional guests. - name: disableNotifications | type: boolean | description: Whether notifications are disabled. - name: onlineConferencingLogin | type: OnlineConferencingLogin | description: Guest login details for accessing the online conference event. - name: link | type: string | description: Link URL to the online conference. - name: password | type: string | description: Password for the online conference. - name: anonymized | type: boolean | description: Whether an RSVP is anonymized. - name: marketingConsent | type: boolean | description: Whether a guest agreed to marketing. - name: extendedFields | type: ExtendedFields | description: Custom field data for the RSVP object. **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: pagingMetadata | type: CursorPagingMetadata | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### Query RSVP with the DETAILS and CONTACT_DETAILS fields ```curl curl -X POST 'https://www.wixapis.com/events/v2/rsvps/query' \ -H 'Authorization: ' \ -d '{ "query": { "filter": { "eventId": "e1beee02-f915-4414-9b25-3082aaa89c19" }, "sort": [ { "order": "DESC", "fieldName": "createdDate" } ], "cursorPaging": { "limit": 1 } }, "fields": [ "DETAILS", "CONTACT_DETAILS" ] }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.registration.RsvpManagement.queryRsvps(query, options) Description: 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`. To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language.md), [Sorting and Paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging.md), and [Field Projection](https://dev.wix.com/docs/rest/articles/get-started/field-projection.md). > **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` # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: options | type: QueryRsvpsOptions none - name: fields | type: array | description: Predefined sets of fields to return. - enum: - DETAILS: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`. - FORM: Returns `form`. - CONTACT_DETAILS: Returns `email`. param name: query | type: RsvpQuery | required: true - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` - name: sort | type: array | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: - ASC: Sort is in the ascending order. - DESC: Sort is in the descending order. Return type: PROMISE - name: rsvps | type: array | description: Retrieved RSVPs. - name: _id | type: string | description: GUID of the RSVP. - name: revision | type: string | description: Revision number, which increments by 1 each time the RSVP is updated. To prevent conflicting changes, the existing `revision` must be used when updating the RSVP. - name: eventId | type: string | description: Event GUID to which the RSVP belongs. - name: _createdDate | type: Date | description: Date and time the RSVP was created. - name: _updatedDate | type: Date | description: Date and time the RSVP was updated. - name: memberId | type: string | description: Site member GUID. - name: contactId | type: string | description: Contact GUID of a guest who filled in the RSVP form. See the Contacts API for more details. - name: firstName | type: string | description: First name of a guest who filled in the RSVP form. - name: lastName | type: string | description: Last name of a guest who filled in the RSVP form. - name: email | type: string | description: Email of a guest who filled in the RSVP form. - name: form | type: FormResponse | description: Event registration form. - name: inputValues | type: array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: array | description: Form field values. - name: status | type: RsvpStatus | description: RSVP response status. - enum: - YES: Guest is attending the event. - NO: Guest isn't attending the event. - WAITLIST: Guest is on a waitlist. - name: totalGuests | type: integer | description: Total number of guests per 1 RSVP. - name: guestList | type: GuestList | description: Guest list. - name: guests | type: array | description: List of guests. - name: index | type: integer | description: Index of each guest in the array. - name: fullName | type: string | description: Full name. - name: checkInDetails | type: CheckInDetails | description: Check-in details. - name: checkedIn | type: boolean | description: Whether the guest has checked in. - name: checkInDate | type: Date | description: Date and time the guest checked in. - name: checkInCanceledDate | type: Date | description: Date and time the guest cancelled check-in. - name: checkedInBy | type: string | description: Id of the user who last performed check-in - name: checkInCanceledBy | type: string | description: Id of the user who last canceled check-in - name: checkedInByStaffMember | type: string | description: Id of the Staff Member who last performed check-in - name: checkInCanceledByStaffMember | type: string | description: Id of theStaff Member who last canceled check-in - name: guestId | type: integer | description: Guest GUID. - name: language | type: string | description: 2-letter language code in the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. - name: locale | type: string | description: Locale in the [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. - name: fullyCheckedIn | type: boolean | description: Whether all guests are checked in. - name: checkedInGuestCount | type: integer | description: Number of checked in guests. - name: additionalGuestDetails | type: AdditionalGuestDetails | description: Additional guest details. - name: guestCount | type: integer | description: Number of additional guests. - name: guestNames | type: array | description: Names of additional guests. - name: disableNotifications | type: boolean | description: Whether notifications are disabled. - name: onlineConferencingLogin | type: OnlineConferencingLogin | description: Guest login details for accessing the online conference event. - name: link | type: string | description: Link URL to the online conference. - name: password | type: string | description: Password for the online conference. - name: anonymized | type: boolean | description: Whether an RSVP is anonymized. - name: marketingConsent | type: boolean | description: Whether a guest agreed to marketing. - name: extendedFields | type: ExtendedFields | description: Custom field data for the RSVP object. **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: pagingMetadata | type: CursorPagingMetadata | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### queryRsvps ```javascript import { rsvpV2 } from '@wix/events'; async function queryRsvps(query,options) { const response = await rsvpV2.queryRsvps(query,options); }; ``` ### queryRsvps (with elevated permissions) ```javascript import { rsvpV2 } from '@wix/events'; import { auth } from '@wix/essentials'; async function myQueryRsvpsMethod(query,options) { const elevatedQueryRsvps = auth.elevate(rsvpV2.queryRsvps); const response = await elevatedQueryRsvps(query,options); } ``` ### queryRsvps (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { rsvpV2 } from '@wix/events'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { rsvpV2 }, // Include the auth strategy and host as relevant }); async function queryRsvps(query,options) { const response = await myWixClient.rsvpV2.queryRsvps(query,options); }; ``` ---