List events on the specified calendar
GET {{baseUrl}}/calendars/:calId/events?maxResults=<integer>&orderBy=startTime&showDeleted=<boolean>&singleEvents=<boolean>&pageToken=<string>&timeMax=<string>&timeMin=<string>&timeZone=<string>
Returns events on the specified calendar.
Scopes: calendar:read,calendar:read:admin
Rate Limit Label: MEDIUM
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
maxResults | string | The maximum number of events returned on one result page. | |
orderBy | string | The order of the events returned in the result. | |
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 and only single instances of deleted events (but not the underlying recurring events) are returned. The default is False. Optional. | |
singleEvents | string | Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. The default is False. Optional. | |
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. It 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 from which to filter. Optional. The default is not to filter by end time. It 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 can be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. | |
timeZone | string | The time zone in the response. The default is the time zone of the calendar. Optional. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"kind":"\u003cstring\u003e","etag":"\u003cstring\u003e","summary":"\u003cstring\u003e","description":{},"updated":"\u003cdateTime\u003e","timeZone":"\u003cstring\u003e","accessRole":"owner","defaultReminders":[{"method":"popup","minutes":"\u003cinteger\u003e"},{"method":"popup","minutes":"\u003cinteger\u003e"}],"nextPageToken":"\u003cstring\u003e","items":[{"end":{"date":"\u003cdate\u003e","dateTime":"\u003cdateTime\u003e","timeZone":"\u003cstring\u003e"},"start":{"date":"\u003cdate\u003e","dateTime":"\u003cdateTime\u003e","timeZone":"\u003cstring\u003e"},"attendees":[{"email":"\u003cemail\u003e","additionalGuests":"\u003cinteger\u003e","displayName":"\u003cstring\u003e","optional":"\u003cboolean\u003e","resource":"\u003cboolean\u003e","responseStatus":"accepted"},{"email":"\u003cemail\u003e","additionalGuests":"\u003cinteger\u003e","displayName":"\u003cstring\u003e","optional":"\u003cboolean\u003e","resource":"\u003cboolean\u003e","responseStatus":"needsAction"}],"colorId":"\u003cstring\u003e","description":"\u003cstring\u003e","guestsCanInviteOthers":"\u003cboolean\u003e","guestsCanModify":"\u003cboolean\u003e","guestsCanSeeOtherGuests":"\u003cboolean\u003e","location":"\u003cstring\u003e","recurrence":["\u003cstring\u003e","\u003cstring\u003e"],"reminders":{"useDefault":"\u003cboolean\u003e","overrides":[{"method":"popup","minutes":"\u003cinteger\u003e"},{"method":"email","minutes":"\u003cinteger\u003e"}]},"status":"cancelled","summary":"\u003cstring\u003e","transparency":"opaque","visibility":"default","id":"\u003cstring\u003e","created":"\u003cstring\u003e","creator":{"email":"\u003cstring\u003e"},"organizer":{"email":"\u003cstring\u003e"},"kind":"\u003cstring\u003e","updated":"\u003cstring\u003e"},{"end":{"date":"\u003cdate\u003e","dateTime":"\u003cdateTime\u003e","timeZone":"\u003cstring\u003e"},"start":{"date":"\u003cdate\u003e","dateTime":"\u003cdateTime\u003e","timeZone":"\u003cstring\u003e"},"attendees":[{"email":"\u003cemail\u003e","additionalGuests":"\u003cinteger\u003e","displayName":"\u003cstring\u003e","optional":"\u003cboolean\u003e","resource":"\u003cboolean\u003e","responseStatus":"needsAction"},{"email":"\u003cemail\u003e","additionalGuests":"\u003cinteger\u003e","displayName":"\u003cstring\u003e","optional":"\u003cboolean\u003e","resource":"\u003cboolean\u003e","responseStatus":"declined"}],"colorId":"\u003cstring\u003e","description":"\u003cstring\u003e","guestsCanInviteOthers":"\u003cboolean\u003e","guestsCanModify":"\u003cboolean\u003e","guestsCanSeeOtherGuests":"\u003cboolean\u003e","location":"\u003cstring\u003e","recurrence":["\u003cstring\u003e","\u003cstring\u003e"],"reminders":{"useDefault":"\u003cboolean\u003e","overrides":[{"method":"popup","minutes":"\u003cinteger\u003e"},{"method":"popup","minutes":"\u003cinteger\u003e"}]},"status":"cancelled","summary":"\u003cstring\u003e","transparency":"transparent","visibility":"public","id":"\u003cstring\u003e","created":"\u003cstring\u003e","creator":{"email":"\u003cstring\u003e"},"organizer":{"email":"\u003cstring\u003e"},"kind":"\u003cstring\u003e","updated":"\u003cstring\u003e"}]}