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 from all connected external calendars, based on the provided filtering and paging.

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 and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings - all permissions
Manage External Calendars
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
optionsListEventsOptions
Returns
Return Type:Promise<ListEventsResponse>
Was this helpful?
Yes
No