/users/me/calendarList

GET

calendarList

Returns the calendars on the user's calendar list.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://www.googleapis.com/calendar/v3/users/me/calendarList'

Response Example

{
  "etag": "string",
  "items": [
    {
      "accessRole": "string",
      "backgroundColor": "string",
      "colorId": "string",
      "conferenceProperties": {
        "allowedConferenceSolutionTypes": [
          "string"
        ]
      },
      "defaultReminders": [
        {
          "method": "string",
          "minutes": 0
        }
      ],
      "deleted": false,
      "description": "string",
      "etag": "string",
      "foregroundColor": "string",
      "hidden": false,
      "id": "string",
      "kind": "calendar#calendarListEntry",
      "location": "string",
      "notificationSettings": {
        "notifications": [
          {
            "method": "string",
            "type": "string"
          }
        ]
      },
      "primary": false,
      "selected": false,
      "summary": "string",
      "summaryOverride": "string",
      "timeZone": "string"
    }
  ],
  "kind": "calendar#calendarList",
  "nextPageToken": "string",
  "nextSyncToken": "string"
}

Request

Query Params

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.

minAccessRole

string

optional

The minimum access role for the user in the returned entries. Optional. The default is no restriction.

pageToken

string

optional

Token specifying which result page to return. Optional.

showDeleted

string

optional

Whether to include deleted calendar list entries in the result. Optional. The default is False.

showHidden

string

optional

Whether to show hidden entries. 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 query parameter 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.

Responses

🟢200Successful response

application/json

Body

etag

string

optional

ETag of the collection.

items

array[object (CalendarListEntry) {19}]

optional

Calendars that are present on the user's calendar list.

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.

"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 ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

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

object (ConferenceProperties)

optional

Conferencing properties for this calendar, for example what types of conferences are allowed.

defaultReminders

array[object (EventReminder) {2}]

optional

The default reminders that the authenticated user has for this calendar.

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

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.

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.

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.

Modified at 2023-08-15 05:59:47

/freeBusy

/users/me/calendarList