listEvents( )

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 a list of events by their IDs.

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 listEvents(
  eventIds: Array<string>,
  options: ListEventsOptions,
): Promise<ListEventsResponse>;
Method Parameters
eventIdsArray<string>Required

IDs of the events to retrieve.

Min: 1 event ID Min: 100 event IDs

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

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

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

Did this help?