Function: headCalendarsByCalendarId()

headCalendarsByCalendarId<ThrowOnError>(options): RequestResult<HeadCalendarsByCalendarIdResponses, HeadCalendarsByCalendarIdErrors, ThrowOnError>

Defined in: api/sdk.gen.ts:229

Retrieves the personal iCalendar feed identified by the given calendar identifier. The GetCalendar endpoint is what a calendar application such as Google Calendar or Outlook subscribes to, and is therefore anonymous: such applications poll the URL on a schedule and cannot present credentials. Access is instead controlled by the calendar identifier itself, which is an unguessable random value that a member can regenerate at any time to revoke a URL that has been shared or leaked. The endpoint also answers HEAD requests, which several calendar applications issue to probe a subscription before fetching it in full. An unknown identifier, or one belonging to a deleted member, yields a 404 without disclosing whether the identifier ever existed.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<HeadCalendarsByCalendarIdData, ThrowOnError>

Returns

RequestResult<HeadCalendarsByCalendarIdResponses, HeadCalendarsByCalendarIdErrors, ThrowOnError>