Zoom Public API Documentation
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: Rate Limit Label: calendar:read,calendar:read:adminHEAVY
Body
PARAM
| 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": "<string>",
"etag": "<string>",
"nextPageToken": "<string>",
"items": [
{
"id": "<email>",
"kind": "<string>",
"etag": "<string>",
"summary": "<string>",
"description": "<string>",
"location": "<string>",
"timeZone": "<string>",
"colorId": "<string>",
"backgroundColor": "<string>",
"foregroundColor": "<string>",
"hidden": "<boolean>",
"selected": "<boolean>",
"accessRole": "reader",
"defaultReminders": [
{
"method": "email",
"minutes": "<integer>"
},
{
"method": "popup",
"minutes": "<integer>"
}
],
"defaultAllDayReminders": [
{
"method": "popup",
"minutes": "<integer>"
},
{
"method": "email",
"minutes": "<integer>"
}
],
"notificationSettings": {
"notifications": [
{
"type": "agenda",
"method": "email"
},
{
"type": "eventResponse",
"method": "email"
}
]
},
"primary": "<boolean>",
"deleted": "<boolean>",
"summaryOverride": "<string>"
},
{
"id": "<email>",
"kind": "<string>",
"etag": "<string>",
"summary": "<string>",
"description": "<string>",
"location": "<string>",
"timeZone": "<string>",
"colorId": "<string>",
"backgroundColor": "<string>",
"foregroundColor": "<string>",
"hidden": "<boolean>",
"selected": "<boolean>",
"accessRole": "freeBusyReader",
"defaultReminders": [
{
"method": "email",
"minutes": "<integer>"
},
{
"method": "popup",
"minutes": "<integer>"
}
],
"defaultAllDayReminders": [
{
"method": "popup",
"minutes": "<integer>"
},
{
"method": "popup",
"minutes": "<integer>"
}
],
"notificationSettings": {
"notifications": [
{
"type": "eventChange",
"method": "email"
},
{
"type": "eventResponse",
"method": "email"
}
]
},
"primary": "<boolean>",
"deleted": "<boolean>",
"summaryOverride": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/calendars/users/:userIdentifier/calendarList?maxResults=<integer>&minAccessRole=writer&pageToken=<string>&showDeleted=<boolean>&showHidden=<boolean>?maxResults=<integer>&minAccessRole=writer&pageToken=<string>&showDeleted=<boolean>&showHidden=<boolean>' -H 'Accept: application/json'
ENDPOINTS