getEvent( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves an event.

Permissions
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Public Data
Read Bookings - Including Participants
Read Bookings Calendar Availability
Read bookings calendar - including participants
Read Bookings Calendar
Manage Calendars
Read Calendar - Including PI
Read Calendar
Learn more about app permissions.
Method Declaration
Copy
function getEvent(eventId: string, options: GetEventOptions): Promise<Event>;
Method Parameters
eventIdstringRequired

ID of the event to retrieve.

Min: 36 characters Max: 250 characters

optionsGetEventOptions
Returns
Return Type:Promise<Event>
JavaScript
import { events } from "@wix/calendar";

async function getEvent(eventId, options) {
  const response = await events.getEvent(eventId, options);
}
Errors

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

Did this help?