List the calendars in the user's own calendarList
GET {{baseUrl}}/calendars/users/:userIdentifier/calendarList?maxResults=<integer>&minAccessRole=writer&pageToken=<string>&showDeleted=<boolean>&showHidden=<boolean>
Returns the calendars in the user's calendar list.
Scopes:
calendar:read
,
calendar:read:admin
Rate Limit Label
:
HEAVY
Request Params
| Key | Datatype | Required | Description |
| maxResults
| string | | The maximum number of entries returned on one result page. |
| minAccessRole
| string | | The minimum access role for the user in the returned entries. |
| pageToken
| string | | The token that specifies which result page to return. |
| showDeleted
| string | | Whether to include deleted calendar list entries in the result. |
| showHidden
| string | | Whether to show hidden entries. |
HEADERS
| Key | Datatype | Required | Description |
| Accept
| string | | |
RESPONSES
status: OK
{"kind":"\u003cstring\u003e","etag":"\u003cstring\u003e","nextPageToken":"\u003cstring\u003e","items":[{"id":"\u003cemail\u003e","kind":"\u003cstring\u003e","etag":"\u003cstring\u003e","summary":"\u003cstring\u003e","description":"\u003cstring\u003e","location":"\u003cstring\u003e","timeZone":"\u003cstring\u003e","colorId":"\u003cstring\u003e","backgroundColor":"\u003cstring\u003e","foregroundColor":"\u003cstring\u003e","hidden":"\u003cboolean\u003e","selected":"\u003cboolean\u003e","accessRole":"reader","defaultReminders":[{"method":"email","minutes":"\u003cinteger\u003e"},{"method":"popup","minutes":"\u003cinteger\u003e"}],"defaultAllDayReminders":[{"method":"popup","minutes":"\u003cinteger\u003e"},{"method":"email","minutes":"\u003cinteger\u003e"}],"notificationSettings":{"notifications":[{"type":"agenda","method":"email"},{"type":"eventResponse","method":"email"}]},"primary":"\u003cboolean\u003e","deleted":"\u003cboolean\u003e","summaryOverride":"\u003cstring\u003e"},{"id":"\u003cemail\u003e","kind":"\u003cstring\u003e","etag":"\u003cstring\u003e","summary":"\u003cstring\u003e","description":"\u003cstring\u003e","location":"\u003cstring\u003e","timeZone":"\u003cstring\u003e","colorId":"\u003cstring\u003e","backgroundColor":"\u003cstring\u003e","foregroundColor":"\u003cstring\u003e","hidden":"\u003cboolean\u003e","selected":"\u003cboolean\u003e","accessRole":"freeBusyReader","defaultReminders":[{"method":"email","minutes":"\u003cinteger\u003e"},{"method":"popup","minutes":"\u003cinteger\u003e"}],"defaultAllDayReminders":[{"method":"popup","minutes":"\u003cinteger\u003e"},{"method":"popup","minutes":"\u003cinteger\u003e"}],"notificationSettings":{"notifications":[{"type":"eventChange","method":"email"},{"type":"eventResponse","method":"email"}]},"primary":"\u003cboolean\u003e","deleted":"\u003cboolean\u003e","summaryOverride":"\u003cstring\u003e"}]}