Search.../
  1. APIs

getRsvp( )

Retrieves an RSVP.

Admin Method

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

Syntax

function getRsvp(rsvpId: string, options: GetRsvpOptions): Promise<Rsvp>

getRsvp Parameters

NAME
TYPE
DESCRIPTION
rsvpId
string

RSVP ID.

options
Optional
GetRsvpOptions

Optional fields.

Returns

RSVP.

Return Type:

Promise<
Rsvp
>
NAME
TYPE
DESCRIPTION
_id
string

RSVP ID.

anonymized
boolean

Whether RSVP is anonymized by GDPR delete.

contactId
string

Contact ID associated with this RSVP.

created
Date

RSVP created timestamp.

email
string

Guest email.

eventId
string

Event ID to which RSVP belongs.

firstName
string

First name.

guests
Array<
Guest
>

List of guests.

lastName
string

Last name.

memberId
string

Member ID associated with this RSVP.

modified
Date

RSVP modified timestamp.

rsvpForm
FormResponse

RSVP form response.

status
string

RSVP response status. Possible values:

  • Yes
  • No
  • Waiting: a guest is in the waitlist.
totalGuests
number

Total number of attendees.

Was this helpful?

getRsvp example

Copy Code
1import { rsvp } from 'wix-events.v2';
2  
3 async function getRsvp(rsvpId, options) {
4   try {
5     const result = await rsvp.getRsvp(rsvpId, options);
6

7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13