POST

Query Rsvp

Deprecated

This method has been replaced with Query Rsvps, and will be removed on June 30, 2025.

Retrieves a list of up to 100 RSVPs, supporting structurized queries.

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/v1/rsvp/query
Body Params
offsetintegerminimum 0

Offset. See Pagination.

limitintegerminimum 0maximum 100

Limit. See Pagination.

fieldsetArray <string>maxItems 20

Control which data is returned. See Fieldset.

filterstruct

Filter. See supported fields and operators.

memberIdArray <string>format GUIDmaxItems 500

Site member ID.

facetArray <string>maxLength 100maxItems 20

Filter facets to include in the response. See supported facets.

searchPhrasestringmaxLength 200

Textual search filter - search is performed on "guests.full_name".

eventCreatorIdArray <string>format GUIDmaxItems 50

Event creator ID.

sortstringmaxLength 100

Sort order, defaults to "created:asc". See supported fields.

contactIdArray <string>format GUIDmaxItems 100

Contact ID.

tagArray <string>

RSVP tag

Response Object
totalinteger

Total RSVPs matching the given filters.

offsetintegerminimum 0

Offset.

limitintegerminimum 0maximum 100

Limit.

rsvpsArray <Rsvp>

RSVP list.

facetsMap <string, FacetCounts>format map

Facet query result.

rsvpFacetsRsvpFacets

Rsvp data enriched facets.

Query Rsvp Example 1
Request
cURL
curl -X POST 'https://www.wixapis.com/events/v1/rsvp/query' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
--data-binary '{
                 "offset": 0,
                 "limit": 2,
                 "order": "created:desc",
                 "filter": {
                   "status": {
                     "$hasSome": [ "YES", "NO" ]
                   }
                 },
                 "fieldset": [],
                 "facet": [
                   "status"
                 ]
               }'
Response
JSON
{
  "total": 102,
  "offset": 0,
  "limit": 2,
  "rsvps": [
    {
      "id": "8234bc18-65d9-4016-9937-003f67666aa5",
      "eventId": "fd56076c-38f4-4705-b9eb-ec322b85c745",
      "contactId": "c9294dfd-ea55-4f51-a4a0-1c0df504c962",
      "memberId": "",
      "firstName": "",
      "lastName": "",
      "email": "",
      "status": "NO",
      "totalGuests": 0,
      "guests": [],
      "anonymized": false
    },
    {
      "id": "fb97100a-98e2-4579-a61c-e71a3501b085",
      "eventId": "fd56076c-38f4-4705-b9eb-ec322b85c745",
      "contactId": "46df035c-a6af-4947-8675-4306255ba88f",
      "memberId": "",
      "firstName": "",
      "lastName": "",
      "email": "",
      "status": "YES",
      "totalGuests": 0,
      "guests": [],
      "anonymized": false
    }
  ],
  "facets": {
    "status": {
      "counts": {
        "YES": 95,
        "NO": 7
      }
    }
  },
  "rsvpFacets": {
    "facets": {
      "status": {
        "counts": {
          "YES": {
            "count": 95,
            "guests": 98,
            "guestsCheckIn": 4
          },
          "NO": {
            "count": 7,
            "guests": 9,
            "guestsCheckIn": 3
          }
        }
      }
    }
  }
}
Errors

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

Did this help?