API

Every googlecalendar.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Calendar

getAvailability

calendar.getAvailability Get free/busy availability for a calendar Risk: read

await corsair.googlecalendar.api.calendar.getAvailability({});

Input

Name	Type	Required	Description
`timeMin`	`string`	Yes	—
`timeMax`	`string`	Yes	—
`timeZone`	`string`	No	—
`groupExpansionMax`	`number`	No	—
`calendarExpansionMax`	`number`	No	—
`items`	`object[]`	No	—

items full type

{
  id: string
}[]

Output

Name	Type	Required	Description
`kind`	`string`	No	—
`calendars`	`object`	No	—
`groups`	`object`	No	—
`timeMin`	`string`	No	—
`timeMax`	`string`	No	—

calendars full type

{
}

groups full type

{
}

Events

create

events.create Create a new calendar event Risk: write

await corsair.googlecalendar.api.events.create({});

Input

Name	Type	Required	Description
`calendarId`	`string`	No	—
`event`	`object`	Yes	Event body. Provide at minimum “summary”, “start”, and “end”.
`sendUpdates`	`all \| externalOnly \| none`	No	—
`sendNotifications`	`boolean`	No	—
`conferenceDataVersion`	`number`	No	—
`maxAttendees`	`number`	No	—
`supportsAttachments`	`boolean`	No	—

event full type

{
  summary?: string,
  description?: string,
  location?: string,
  start?: {
    date?: string,
    dateTime?: string,
    timeZone?: string
  },
  end?: {
    date?: string,
    dateTime?: string,
    timeZone?: string
  },
  attendees?: {
    id?: string,
    email?: string,
    displayName?: string,
    organizer?: boolean,
    self?: boolean,
    resource?: boolean,
    optional?: boolean,
    responseStatus?: needsAction | declined | tentative | accepted,
    comment?: string,
    additionalGuests?: number
  }[],
  recurrence?: string[],
  colorId?: string,
  transparency?: opaque | transparent,
  visibility?: default | public | private | confidential,
  eventType?: default | outOfOffice | focusTime | workingLocation,
  status?: confirmed | tentative | cancelled,
  reminders?: {
    useDefault?: boolean,
    overrides?: {
      method?: email | popup,
      minutes?: number
    }[]
  },
  guestsCanModify?: boolean,
  guestsCanInviteOthers?: boolean,
  guestsCanSeeOtherGuests?: boolean,
  anyoneCanAddSelf?: boolean,
  sequence?: number,
  originalStartTime?: {
    date?: string,
    dateTime?: string,
    timeZone?: string
  },
  recurringEventId?: string
}

Output

Name	Type	Required	Description
`id`	`string`	No	—
`status`	`confirmed \| tentative \| cancelled`	No	—
`htmlLink`	`string`	No	—
`created`	`string`	No	—
`updated`	`string`	No	—
`summary`	`string`	No	—
`description`	`string`	No	—
`location`	`string`	No	—
`colorId`	`string`	No	—
`creator`	`object`	No	—
`organizer`	`object`	No	—
`start`	`object`	No	—
`end`	`object`	No	—
`endTimeUnspecified`	`boolean`	No	—
`recurrence`	`string[]`	No	—
`recurringEventId`	`string`	No	—
`originalStartTime`	`object`	No	—
`transparency`	`opaque \| transparent`	No	—
`visibility`	`default \| public \| private \| confidential`	No	—
`iCalUID`	`string`	No	—
`sequence`	`number`	No	—
`attendees`	`object[]`	No	—
`attendeesOmitted`	`boolean`	No	—
`hangoutLink`	`string`	No	—
`reminders`	`object`	No	—
`anyoneCanAddSelf`	`boolean`	No	—
`guestsCanInviteOthers`	`boolean`	No	—
`guestsCanModify`	`boolean`	No	—
`guestsCanSeeOtherGuests`	`boolean`	No	—
`privateCopy`	`boolean`	No	—
`locked`	`boolean`	No	—
`eventType`	`default \| outOfOffice \| focusTime \| workingLocation`	No	—

creator full type

{
  id?: string,
  email?: string,
  displayName?: string,
  self?: boolean
}

organizer full type

{
  id?: string,
  email?: string,
  displayName?: string,
  self?: boolean
}

start full type

{
  date?: string,
  dateTime?: string,
  timeZone?: string
}

end full type

{
  date?: string,
  dateTime?: string,
  timeZone?: string
}

originalStartTime full type

{
  date?: string,
  dateTime?: string,
  timeZone?: string
}

attendees full type

{
  id?: string,
  email?: string,
  displayName?: string,
  organizer?: boolean,
  self?: boolean,
  resource?: boolean,
  optional?: boolean,
  responseStatus?: needsAction | declined | tentative | accepted,
  comment?: string,
  additionalGuests?: number
}[]

reminders full type

{
  useDefault?: boolean,
  overrides?: {
    method?: email | popup,
    minutes?: number
  }[]
}

delete

events.delete Delete a calendar event [DESTRUCTIVE] Risk: destructive

await corsair.googlecalendar.api.events.delete({});

Input

Name	Type	Required	Description
`calendarId`	`string`	No	—
`id`	`string`	Yes	—
`sendUpdates`	`all \| externalOnly \| none`	No	—
`sendNotifications`	`boolean`	No	—

Output: void

get

events.get Get a specific calendar event Risk: read

await corsair.googlecalendar.api.events.get({});

Input

Name	Type	Required	Description
`calendarId`	`string`	No	—
`id`	`string`	Yes	—
`timeZone`	`string`	No	—
`maxAttendees`	`number`	No	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`status`	`confirmed \| tentative \| cancelled`	No	—
`htmlLink`	`string`	No	—
`created`	`string`	No	—
`updated`	`string`	No	—
`summary`	`string`	No	—
`description`	`string`	No	—
`location`	`string`	No	—
`colorId`	`string`	No	—
`creator`	`object`	No	—
`organizer`	`object`	No	—
`start`	`object`	No	—
`end`	`object`	No	—
`endTimeUnspecified`	`boolean`	No	—
`recurrence`	`string[]`	No	—
`recurringEventId`	`string`	No	—
`originalStartTime`	`object`	No	—
`transparency`	`opaque \| transparent`	No	—
`visibility`	`default \| public \| private \| confidential`	No	—
`iCalUID`	`string`	No	—
`sequence`	`number`	No	—
`attendees`	`object[]`	No	—
`attendeesOmitted`	`boolean`	No	—
`hangoutLink`	`string`	No	—
`reminders`	`object`	No	—
`anyoneCanAddSelf`	`boolean`	No	—
`guestsCanInviteOthers`	`boolean`	No	—
`guestsCanModify`	`boolean`	No	—
`guestsCanSeeOtherGuests`	`boolean`	No	—
`privateCopy`	`boolean`	No	—
`locked`	`boolean`	No	—
`eventType`	`default \| outOfOffice \| focusTime \| workingLocation`	No	—

creator full type

{
  id?: string,
  email?: string,
  displayName?: string,
  self?: boolean
}

organizer full type

{
  id?: string,
  email?: string,
  displayName?: string,
  self?: boolean
}

start full type

{
  date?: string,
  dateTime?: string,
  timeZone?: string
}

end full type

{
  date?: string,
  dateTime?: string,
  timeZone?: string
}

originalStartTime full type

{
  date?: string,
  dateTime?: string,
  timeZone?: string
}

attendees full type

{
  id?: string,
  email?: string,
  displayName?: string,
  organizer?: boolean,
  self?: boolean,
  resource?: boolean,
  optional?: boolean,
  responseStatus?: needsAction | declined | tentative | accepted,
  comment?: string,
  additionalGuests?: number
}[]

reminders full type

{
  useDefault?: boolean,
  overrides?: {
    method?: email | popup,
    minutes?: number
  }[]
}

getMany

events.getMany List calendar events Risk: read

await corsair.googlecalendar.api.events.getMany({});

Input

Name	Type	Required	Description
`calendarId`	`string`	No	—
`timeMin`	`string`	No	—
`timeMax`	`string`	No	—
`timeZone`	`string`	No	—
`updatedMin`	`string`	No	—
`singleEvents`	`boolean`	No	—
`maxResults`	`number`	No	—
`pageToken`	`string`	No	—
`q`	`string`	No	—
`orderBy`	`startTime \| updated`	No	—
`iCalUID`	`string`	No	—
`showDeleted`	`boolean`	No	—
`showHiddenInvitations`	`boolean`	No	—

Output

Name	Type	Required	Description
`kind`	`string`	No	—
`etag`	`string`	No	—
`summary`	`string`	No	—
`description`	`string`	No	—
`updated`	`string`	No	—
`timeZone`	`string`	No	—
`accessRole`	`string`	No	—
`defaultReminders`	`object[]`	No	—
`nextPageToken`	`string`	No	—
`nextSyncToken`	`string`	No	—
`items`	`object[]`	No	—

defaultReminders full type

{
  method?: email | popup,
  minutes?: number
}[]

items full type

{
  id?: string,
  status?: confirmed | tentative | cancelled,
  htmlLink?: string,
  created?: string,
  updated?: string,
  summary?: string,
  description?: string,
  location?: string,
  colorId?: string,
  creator?: {
    id?: string,
    email?: string,
    displayName?: string,
    self?: boolean
  },
  organizer?: {
    id?: string,
    email?: string,
    displayName?: string,
    self?: boolean
  },
  start?: {
    date?: string,
    dateTime?: string,
    timeZone?: string
  },
  end?: {
    date?: string,
    dateTime?: string,
    timeZone?: string
  },
  endTimeUnspecified?: boolean,
  recurrence?: string[],
  recurringEventId?: string,
  originalStartTime?: {
    date?: string,
    dateTime?: string,
    timeZone?: string
  },
  transparency?: opaque | transparent,
  visibility?: default | public | private | confidential,
  iCalUID?: string,
  sequence?: number,
  attendees?: {
    id?: string,
    email?: string,
    displayName?: string,
    organizer?: boolean,
    self?: boolean,
    resource?: boolean,
    optional?: boolean,
    responseStatus?: needsAction | declined | tentative | accepted,
    comment?: string,
    additionalGuests?: number
  }[],
  attendeesOmitted?: boolean,
  hangoutLink?: string,
  reminders?: {
    useDefault?: boolean,
    overrides?: {
      method?: email | popup,
      minutes?: number
    }[]
  },
  anyoneCanAddSelf?: boolean,
  guestsCanInviteOthers?: boolean,
  guestsCanModify?: boolean,
  guestsCanSeeOtherGuests?: boolean,
  privateCopy?: boolean,
  locked?: boolean,
  eventType?: default | outOfOffice | focusTime | workingLocation
}[]

update

events.update Update an existing calendar event Risk: write

await corsair.googlecalendar.api.events.update({});

Input

Name	Type	Required	Description
`calendarId`	`string`	No	—
`id`	`string`	Yes	Event ID to update
`event`	`object`	Yes	Updated event fields
`sendUpdates`	`all \| externalOnly \| none`	No	—
`sendNotifications`	`boolean`	No	—
`conferenceDataVersion`	`number`	No	—
`maxAttendees`	`number`	No	—
`supportsAttachments`	`boolean`	No	—

event full type

{
  summary?: string,
  description?: string,
  location?: string,
  start?: {
    date?: string,
    dateTime?: string,
    timeZone?: string
  },
  end?: {
    date?: string,
    dateTime?: string,
    timeZone?: string
  },
  attendees?: {
    id?: string,
    email?: string,
    displayName?: string,
    organizer?: boolean,
    self?: boolean,
    resource?: boolean,
    optional?: boolean,
    responseStatus?: needsAction | declined | tentative | accepted,
    comment?: string,
    additionalGuests?: number
  }[],
  recurrence?: string[],
  colorId?: string,
  transparency?: opaque | transparent,
  visibility?: default | public | private | confidential,
  eventType?: default | outOfOffice | focusTime | workingLocation,
  status?: confirmed | tentative | cancelled,
  reminders?: {
    useDefault?: boolean,
    overrides?: {
      method?: email | popup,
      minutes?: number
    }[]
  },
  guestsCanModify?: boolean,
  guestsCanInviteOthers?: boolean,
  guestsCanSeeOtherGuests?: boolean,
  anyoneCanAddSelf?: boolean,
  sequence?: number,
  originalStartTime?: {
    date?: string,
    dateTime?: string,
    timeZone?: string
  },
  recurringEventId?: string
}

Output

Name	Type	Required	Description
`id`	`string`	No	—
`status`	`confirmed \| tentative \| cancelled`	No	—
`htmlLink`	`string`	No	—
`created`	`string`	No	—
`updated`	`string`	No	—
`summary`	`string`	No	—
`description`	`string`	No	—
`location`	`string`	No	—
`colorId`	`string`	No	—
`creator`	`object`	No	—
`organizer`	`object`	No	—
`start`	`object`	No	—
`end`	`object`	No	—
`endTimeUnspecified`	`boolean`	No	—
`recurrence`	`string[]`	No	—
`recurringEventId`	`string`	No	—
`originalStartTime`	`object`	No	—
`transparency`	`opaque \| transparent`	No	—
`visibility`	`default \| public \| private \| confidential`	No	—
`iCalUID`	`string`	No	—
`sequence`	`number`	No	—
`attendees`	`object[]`	No	—
`attendeesOmitted`	`boolean`	No	—
`hangoutLink`	`string`	No	—
`reminders`	`object`	No	—
`anyoneCanAddSelf`	`boolean`	No	—
`guestsCanInviteOthers`	`boolean`	No	—
`guestsCanModify`	`boolean`	No	—
`guestsCanSeeOtherGuests`	`boolean`	No	—
`privateCopy`	`boolean`	No	—
`locked`	`boolean`	No	—
`eventType`	`default \| outOfOffice \| focusTime \| workingLocation`	No	—

creator full type

{
  id?: string,
  email?: string,
  displayName?: string,
  self?: boolean
}

organizer full type

{
  id?: string,
  email?: string,
  displayName?: string,
  self?: boolean
}

start full type

{
  date?: string,
  dateTime?: string,
  timeZone?: string
}

end full type

{
  date?: string,
  dateTime?: string,
  timeZone?: string
}

originalStartTime full type

{
  date?: string,
  dateTime?: string,
  timeZone?: string
}

attendees full type

{
  id?: string,
  email?: string,
  displayName?: string,
  organizer?: boolean,
  self?: boolean,
  resource?: boolean,
  optional?: boolean,
  responseStatus?: needsAction | declined | tentative | accepted,
  comment?: string,
  additionalGuests?: number
}[]

reminders full type

{
  useDefault?: boolean,
  overrides?: {
    method?: email | popup,
    minutes?: number
  }[]
}

Overview

Plugins

Calendar

getAvailability

Events

create

delete

get

getMany

update

Overview

Plugins

​Calendar

​getAvailability

​Events

​create

​delete

​get

​getMany

​update

Calendar

getAvailability

Events

create

delete

get

getMany

update