listEvents( )

Developer Preview

Retrieves a list of events from all connected external calendars, based on the provided filtering and paging.

Description

Use List Events to retrieve an aggregated list of events in the connected external calendars for a specified time range, sorted by start date.

Note: Before using this function, establish a connection with an external calendar using connectByCredentials() or connectByOAuth().

Admin Method

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

Syntax

function listEvents(options: ListEventsOptions): Promise<ListEventsResponse>

listEvents Parameters

NAME

TYPE

DESCRIPTION

options

Optional

ListEventsOptions

Returns

Return Type:

Promise<

ListEventsResponse

NAME

TYPE

DESCRIPTION

events

Array<

Event

List of external calendar events matching the filters.

failedProviderIds

Array<

string

List of provider IDs for connections for which retrieval of events failed. Returned only if partialFailure parameter is true in the request.

pagingMetadata

CursorPagingMetadata

Paging metadata.

Was this helpful?

List all events within a time range

Copy Code

1import {externalCalendars} from 'wix-bookings.v2';
2
3async function listEvents() {
4    const options = {
5        from: '2023-01-01T00:00:00Z',
6        to: '2023-01-07T00:00:00Z'
7    }
8    const {events} = await externalCalendars.listEvents(options)
9    return events
10}

List events connected to a specified schedule

Copy Code

1import {externalCalendars} from 'wix-bookings.v2';
2
3async function listScheduleEvents(from, to) {
4    const options = {
5        from,
6        to,
7        scheduleId: 'b936298d-18a6-4ae8-8e9f-10bf49314c95'
8    }
9    const {events: eventsOfSchedule} = await externalCalendars.listEvents(options)
10    return eventsOfSchedule
11}

List events including personal information

Copy Code

1import {externalCalendars} from 'wix-bookings.v2';
2
3async function listEventsWithPI(from, to) {
4    const options = {
5        from,
6        to,
7        fieldsets: ['OWN_PI']
8    }
9    const {events: eventsWithPI} = await externalCalendars.listEvents(options)
10    return eventsWithPI
11}