POST

Search Rsvps


Retrieves a list of RSVPs that match the provided search query and optionally performs aggregations on the data queried.

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

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v2/rsvps/search

Body Params
searchSearch

Search options. See API Query Language for more details.


fieldsArray <string>maxItems 3

Predefined sets of fields to return.

Response Object
rsvpsArray <Rsvp>

List of RSVPs.


pagingMetadataPagingMetadata

Metadata for the paginated results.


aggregationDataAggregationData

Aggregation data.

Search RSVPs
Request
cURL
curl -X POST 'https://www.wixapis.com/events-rsvps/v2/rsvps/search' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ -d '{ "search": { "sort": [ { "fieldName": "lastName", "order": "ASC" } ], "filter": { "status": "YES" }, "cursorPaging": { "limit": 1 } }, "fields": [ "DETAILS", "FORM" ] }'
Response
JSON
{ "rsvps": [ { "id": "d706f4a4-f533-4760-8b53-c26cdbeb9ab0", "revision": "1", "eventId": "97dacca6-9ec0-4b7d-892a-33841b9d7bac", "createdDate": "2024-10-25T10:35:38.781Z", "updatedDate": "2024-10-25T10:35:38.781Z", "memberId": null, "contactId": "6ed64984-f408-41da-9c4c-69ab800f6674", "firstName": "John", "lastName": "Doe", "email": null, "form": { "inputValues": [ { "inputName": "firstName", "value": "John", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "lastName", "value": "Doe", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "email", "value": "john.doe@test.com", "values": [], "number": null, "dateTime": null, "address": null } ] }, "status": "YES", "totalGuests": 1, "guestList": { "guests": [ { "index": 0, "fullName": "John Doe", "checkInDetails": { "checkedIn": false, "checkInDate": null }, "guestId": 1 } ] }, "language": null, "locale": null, "fullyCheckedIn": false, "checkedInGuestCount": 0, "additionalGuestDetails": null, "disableNotifications": false, "onlineConferencingLogin": null, "anonymized": false, "emailDomain": null, "extendedFields": null } ], "pagingMetadata": { "count": 1, "cursors": { "next": "4b1061c51b6d38c7fa08250aa9c126684966faa9.EloKCGxhc3ROYW1lGk4aTDBLbldsRW5HRG82VnF4TFdVU0R8b05NY2VHV2dFSGJsMEpJZ1VlWkZYVG1nfHp0YVZaanZYanhlZm0yMmhlRUlSNkVsSk9wfDcwTDgSCRoFGgMxLjAgARIqGiYaJGQ3MDZmNGE0LWY1MzMtNDc2MC04YjUzLWMyNmNkYmViOWFiMCABIhEKDwoGc3RhdHVzEgUaA1lFU1ABWhpuaWxlL3dpeC5ldmVudHMudjIucnN2cC12MWImCiRiZDZjNDZmOC0zNGJkLTRkOWMtODc4NC0zODgxOWE5MWEzMjA", "prev": null }, "hasNext": true }, "aggregationData": null }
Errors

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

Did this help?