listCalendars

Most users have more than one calendar, such as work, personal and a shared team calendar. listCalendars returns every one they can see, so you can let them pick.

import { listCalendars } from '@cal-sdk/core';

const { calendars } = await listCalendars({ calendar });

OptionsCopy Anchor Link

Only the common options.

ResultCopy Anchor Link

calendarsCalendar[]

Every calendar the user can see. Exactly one has isPrimary: true.

warningsWarning[]

See Calendar for the fields of each calendar, and Calendars for what 'primary' means on each provider.

ThrowsCopy Anchor Link

• AuthenticationError when the credentials are rejected.