Zoom Public API Documentation
List all instances of the specified recurring event
GET {{baseUrl}}/calendars/:calId/events/:eventId/instances?maxResults=<integer>&showDeleted=<boolean>&pageToken=<string>&timeMax=<string>&timeMin=<string>&timeZone=<string>
Returns instances of the specified recurring event. Scopes: Rate Limit Label: calendar:read,calendar:read:adminMEDIUM
Body
PARAM
| Key | Datatype | Required | Description |
maxResults
|
string | The maximum number of events returned on one result page. | |
showDeleted
|
string | Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if `showDeleted` and `singleEvents` are both False. If `showDeleted` and `singleEvents` are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. | |
pageToken
|
string | The token that specifies which result page to return. Optional. | |
timeMax
|
string | The upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If `timeMin` is set, `timeMax` must be greater than `timeMin`. | |
timeMin
|
string | The lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If `timeMax` is set, `timeMin` must be smaller than `timeMax`. | |
timeZone
|
string | The time zone in the response. Optional. The default is the time zone of the calendar. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"kind": "<string>",
"etag": "<string>",
"summary": "<string>",
"description": "<string>",
"updated": "<dateTime>",
"timeZone": "<string>",
"accessRole": "freeBusyReader",
"defaultReminders": [
{
"method": "popup",
"minutes": "<integer>"
},
{
"method": "popup",
"minutes": "<integer>"
}
],
"nextPageToken": "<string>",
"items": [
{
"end": {
"date": "<date>",
"dateTime": "<dateTime>",
"timeZone": "<string>"
},
"start": {
"date": "<date>",
"dateTime": "<dateTime>",
"timeZone": "<string>"
},
"attendees": [
{
"email": "<email>",
"additionalGuests": "<integer>",
"displayName": "<string>",
"optional": "<boolean>",
"resource": "<boolean>",
"responseStatus": "declined"
},
{
"email": "<email>",
"additionalGuests": "<integer>",
"displayName": "<string>",
"optional": "<boolean>",
"resource": "<boolean>",
"responseStatus": "needsAction"
}
],
"colorId": "<string>",
"description": "<string>",
"guestsCanInviteOthers": "<boolean>",
"guestsCanModify": "<boolean>",
"guestsCanSeeOtherGuests": "<boolean>",
"location": "<string>",
"recurrence": [
"<string>",
"<string>"
],
"reminders": {
"useDefault": "<boolean>",
"overrides": [
{
"method": "popup",
"minutes": "<integer>"
},
{
"method": "email",
"minutes": "<integer>"
}
]
},
"status": "confirmed",
"summary": "<string>",
"transparency": "transparent",
"visibility": "private",
"id": "<string>",
"created": "<string>",
"creator": {
"email": "<string>"
},
"organizer": {
"email": "<string>"
},
"kind": "<string>",
"updated": "<string>"
},
{
"end": {
"date": "<date>",
"dateTime": "<dateTime>",
"timeZone": "<string>"
},
"start": {
"date": "<date>",
"dateTime": "<dateTime>",
"timeZone": "<string>"
},
"attendees": [
{
"email": "<email>",
"additionalGuests": "<integer>",
"displayName": "<string>",
"optional": "<boolean>",
"resource": "<boolean>",
"responseStatus": "tentative"
},
{
"email": "<email>",
"additionalGuests": "<integer>",
"displayName": "<string>",
"optional": "<boolean>",
"resource": "<boolean>",
"responseStatus": "needsAction"
}
],
"colorId": "<string>",
"description": "<string>",
"guestsCanInviteOthers": "<boolean>",
"guestsCanModify": "<boolean>",
"guestsCanSeeOtherGuests": "<boolean>",
"location": "<string>",
"recurrence": [
"<string>",
"<string>"
],
"reminders": {
"useDefault": "<boolean>",
"overrides": [
{
"method": "email",
"minutes": "<integer>"
},
{
"method": "popup",
"minutes": "<integer>"
}
]
},
"status": "confirmed",
"summary": "<string>",
"transparency": "transparent",
"visibility": "private",
"id": "<string>",
"created": "<string>",
"creator": {
"email": "<string>"
},
"organizer": {
"email": "<string>"
},
"kind": "<string>",
"updated": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/calendars/:calId/events/:eventId/instances?maxResults=<integer>&showDeleted=<boolean>&pageToken=<string>&timeMax=<string>&timeMin=<string>&timeZone=<string>?maxResults=<integer>&showDeleted=<boolean>&pageToken=<string>&timeMax=<string>&timeMin=<string>&timeZone=<string>' -H 'Accept: application/json'
ENDPOINTS