Google: Returns the calendars on the user's calendar list

← Calendar calendar list operations · Get started

Operation google.calendar_calendarlist_list

Provider route: GET /calendar/v3/users/me/calendarList. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["calendarCalendarList"]["calendarCalendarListList"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.calendarCalendarList.calendarCalendarListList(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.calendar_calendar_list.calendar_calendar_list_list(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	Model	Optional	Expand Watch for changes to Calendar List resources — request body — query

Referenced models: Watch for changes to Calendar List resources — request body — query

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Returns the calendars on the user’s calendar list — response body

Referenced models: Returns the calendars on the user’s calendar list — response body

Schemas

Returns the calendars on the user's calendar list — response body

Field	Type	Presence	Description and constraints
$	object	Root
etag	string	Optional	ETag of the collection.
items	array	Optional	Calendars that are present on the user's calendar list.
items[]	Model	Each item	Expand Returns a calendar from the user's calendar list — response body
kind	string	Optional	Type of the collection ("calendar#calendarList"). Default: calendar#calendarList
nextPageToken	string	Optional	Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
nextSyncToken	string	Optional	Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.

Referenced models: Returns a calendar from the user's calendar list — response body

Watch for changes to Calendar List resources — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fields	string	Optional	Selector specifying which fields to include in a partial response.
prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
quotaUser	string	Optional	An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIp	string	Optional	Deprecated. Please use quotaUser instead.
maxResults	integer	Optional	Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. Format: int32 Minimum: 1
minAccessRole	string	Optional	The minimum access role for the user in the returned entries. Optional. The default is no restriction. One of: freeBusyReader, owner, reader, writer, writerWithoutPrivateAccess
pageToken	string	Optional	Token specifying which result page to return. Optional.
showDeleted	boolean	Optional	Whether to include deleted calendar list entries in the result. Optional. The default is False.
showHidden	boolean	Optional	Whether to show hidden entries. Optional. The default is False.
showOwnOrganizationOnly	boolean	Optional	Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.
syncToken	string	Optional	Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

Returns a calendar from the user's calendar list — response body

Field	Type	Presence	Description and constraints
$	object	Root
accessRole	string	Optional	The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.
autoAcceptInvitations	boolean	Optional	Whether this calendar automatically accepts invitations. Only valid for resource calendars. Read-only.
backgroundColor	string	Optional	The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
colorId	string	Optional	The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
conferenceProperties	Model	Optional	Expand Returns metadata for a calendar — response body — conference Properties Conferencing properties for this calendar, for example what types of conferences are allowed.
dataOwner	string	Optional	The email of the owner of the calendar. Set only for secondary calendars. Read-only.
defaultReminders	array	Optional	The default reminders that the authenticated user has for this calendar.
defaultReminders[]	Model	Each item	Expand Returns events on the specified calendar — response body — default Reminders item
deleted	boolean	Optional	Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. Default: false
description	string	Optional	Description of the calendar. Optional. Read-only.
etag	string	Optional	ETag of the resource.
foregroundColor	string	Optional	The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
hidden	boolean	Optional	Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true. Default: false
id	string	Optional	Identifier of the calendar.
kind	string	Optional	Type of the resource ("calendar#calendarListEntry"). Default: calendar#calendarListEntry
location	string	Optional	Geographic location of the calendar as free-form text. Optional. Read-only.
notificationSettings	object	Optional	The notifications that the authenticated user is receiving for this calendar.
notificationSettings.notifications	array	Optional	The list of notifications set for this calendar.
notificationSettings.notifications[]	Model	Each item	Expand Returns a calendar from the user's calendar list — response body — notification Settings notifications item
primary	boolean	Optional	Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. Default: false
selected	boolean	Optional	Whether the calendar content shows up in the calendar UI. Optional. The default is False. Default: false
summary	string	Optional	Title of the calendar. Read-only.
summaryOverride	string	Optional	The summary that the authenticated user has set for this calendar. Optional.
timeZone	string	Optional	The time zone of the calendar. Optional. Read-only.

Referenced models: Returns a calendar from the user's calendar list — response body — notification Settings notifications item, Returns metadata for a calendar — response body — conference Properties, Returns events on the specified calendar — response body — default Reminders item

Returns a calendar from the user's calendar list — response body — notification Settings notifications item

Field	Type	Presence	Description and constraints
$	object	Root
method	string	Optional	The method used to deliver the notification. The possible value is: - "email" - Notifications are sent via email. Required when adding a notification.
type	string	Optional	The type of notification. Possible values are: - "eventCreation" - Notification sent when a new event is put on the calendar. - "eventChange" - Notification sent when an event is changed. - "eventCancellation" - Notification sent when an event is cancelled. - "eventResponse" - Notification sent when an attendee responds to the event invitation. - "agenda" - An agenda with the events of the day (sent out in the morning). Required when adding a notification.

Returns metadata for a calendar — response body — conference Properties

Field	Type	Presence	Description and constraints
$	object	Root
allowedConferenceSolutionTypes	array	Optional	The types of conference solutions that are supported for this calendar. The possible values are: - "eventHangout" - "eventNamedHangout" - "hangoutsMeet" Optional.
allowedConferenceSolutionTypes[]	string	Each item

Returns events on the specified calendar — response body — default Reminders item

Field	Type	Presence	Description and constraints
$	object	Root
method	string	Optional	The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - "popup" - Reminders are sent via a UI popup. Required when adding a reminder.
minutes	JSON	Optional
minutes (anyOf 1)	integer	Alternative	Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder. Format: int32
minutes (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: google.calendar_calendarlist_list. Catalog operation: calendar.calendarList.list. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.calendarlist", "https://www.googleapis.com/auth/calendar.calendarlist.readonly", "https://www.googleapis.com/auth/calendar.readonly"]

Official provider source