Returns events on the specified calendar. Try it now or see an example.
Request
HTTP request
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
calendarId |
string |
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary " keyword.
|
Optional query parameters | ||
alwaysIncludeEmail |
boolean |
Deprecated and ignored. |
eventTypes |
string |
Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.
Acceptable values are:
|
iCalUID |
string |
Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID. |
maxAttendees |
integer |
The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. |
maxResults |
integer |
Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
|
orderBy |
string |
The order of the events returned in the result. Optional. The default is an unspecified, stable order.
Acceptable values are:
|
pageToken |
string |
Token specifying which result page to return. Optional. |
privateExtendedProperty |
string |
Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. |
q |
string |
Free text search terms to find events that match these terms in the following fields:
These search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for "Office" or "Bureau" returns working location events of type |
sharedExtendedProperty |
string |
Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. |
showDeleted |
boolean |
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.
|
showHiddenInvitations |
boolean |
Whether to include hidden invitations in the result. Optional. The default is False. |
singleEvents |
boolean |
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. Optional. The default is False. |
syncToken |
string |
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. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are:
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. |
timeMax |
datetime |
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 |
datetime |
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 |
Time zone used in the response. Optional. The default is the time zone of the calendar. |
updatedMin |
datetime |
Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted . Optional. The default is not to filter by last modification time.
|
Authorization
This request allows authorization with at least one of the following scopes:
Scope |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events.readonly |
https://www.googleapis.com/auth/calendar.events |
For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "calendar#events", "etag": etag, "summary": string, "description": string, "updated": datetime, "timeZone": string, "accessRole": string, "defaultReminders": [ { "method": string, "minutes": integer } ], "nextPageToken": string, "nextSyncToken": string, "items": [ events Resource ] }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
Type of the collection ("calendar#events "). |
|
etag |
etag |
ETag of the collection. | |
summary |
string |
Title of the calendar. Read-only. | |
description |
string |
Description of the calendar. Read-only. | |
updated |
datetime |
Last modification time of the calendar (as a RFC3339 timestamp). Read-only. | |
timeZone |
string |
The time zone of the calendar. Read-only. | |
accessRole |
string |
The user's access role for this calendar. Read-only. Possible values are:
|
|
defaultReminders[] |
list |
The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True). |
|
defaultReminders[].method |
string |
The method used by this reminder. Possible values are:
Required when adding a reminder. |
writable |
defaultReminders[].minutes |
integer |
Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder. |
writable |
nextPageToken |
string |
Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. |
|
items[] |
list |
List of events on the calendar. | |
nextSyncToken |
string |
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. |
Examples
Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).
Java
Uses the Java client library.
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.Event; import com.google.api.services.calendar.model.Events; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Iterate over the events in the specified calendar String pageToken = null; do { Events events = service.events().list('primary').setPageToken(pageToken).execute(); List<Event> items = events.getItems(); for (Event event : items) { System.out.println(event.getSummary()); } pageToken = events.getNextPageToken(); } while (pageToken != null);
Python
Uses the Python client library.
page_token = None while True: events = service.events().list(calendarId='primary', pageToken=page_token).execute() for event in events['items']: print event['summary'] page_token = events.get('nextPageToken') if not page_token: break
PHP
Uses the PHP client library.
$events = $service->events->listEvents('primary'); while(true) { foreach ($events->getItems() as $event) { echo $event->getSummary(); } $pageToken = $events->getNextPageToken(); if ($pageToken) { $optParams = array('pageToken' => $pageToken); $events = $service->events->listEvents('primary', $optParams); } else { break; } }
Ruby
Uses the Ruby client library.
page_token = nil begin result = client.list_events('primary', page_token: page_token) result.items.each do |e| print e.summary + "\n" end if result.next_page_token != page_token page_token = result.next_page_token else page_token = nil end end while !page_token.nil?
Try it!
Use the APIs Explorer below to call this method on live data and see the response.