Skip to main content

getUpcoming

client.calendar.getUpcoming(params?: CalendarFilterOptions): Promise<CalendarEvent[]>

Retrieves upcoming calendar events.

Returns events scheduled in the near future, sorted chronologically. Useful for displaying "what's next" views.

Parameters

ParameterTypeRequiredDescription
paramsCalendarFilterOptionsNoOptional filter options to customize the results

Returns

Promise<CalendarEvent[]> — A promise that resolves to an array of upcoming CalendarEvent objects

Example

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.calendar.getUpcoming();
console.log(result);