listRsvp( )

Retrieves a list of up to 100 RSVPs.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function listRsvp(options: ListRsvpOptions): Promise<ListRsvpResponse>

listRsvp Parameters

NAME

TYPE

DESCRIPTION

options

Optional

ListRsvpOptions

Optional fields.

Returns

Return Type:

Promise<

ListRsvpResponse

NAME

TYPE

DESCRIPTION

facets

Record<

string

FacetCounts

Facet query result.

limit

number

Limit.

offset

number

Offset.

rsvpFacets

RsvpFacets

Rsvp data enriched facets.

rsvps

Array<

Rsvp

RSVP list.

total

number

Total RSVPs matching the given filters.

Was this helpful?

listRsvp example

Copy Code

1import { rsvp } from 'wix-events.v2';
2  
3 async function listRsvp(options) {
4   try {
5     const result = await rsvp.listRsvp(options);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13