calendar.calendarList.list
Retrieve calendars from a user's calendar list with filters for access role, hidden or deleted entries, and paginated results.
Instructions
Returns the calendars on the user's calendar list [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, insert, patch, update, watch.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. | |
| pageToken | No | [query parameter] Token specifying which result page to return. Optional. | |
| syncToken | No | [query parameter] 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 contai | |
| maxResults | No | [query parameter] 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. | |
| showHidden | No | [query parameter] Whether to show hidden entries. Optional. The default is False. | |
| showDeleted | No | [query parameter] Whether to include deleted calendar list entries in the result. Optional. The default is False. | |
| minAccessRole | No | [query parameter] The minimum access role for the user in the returned entries. Optional. The default is no restriction. Values: `freeBusyReader` = The user can read free/busy information.; `owner` = The user can read and modify events and access control lists.; `reader` = The user can read events that are not private.; `writer` = The user can read and modify events.; `writerWithoutPrivateAccess` = The user can read and modify events that aren't private. The user can read free/busy information about private events. The user can't modify private events.. | |
| showOwnOrganizationOnly | No | [query parameter] Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| etag | No | ||
| kind | No | ||
| items | No | ||
| nextPageToken | No | ||
| nextSyncToken | No |