Google Calendar API

Events: list

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.
Optional query parameters
alwaysIncludeEmail boolean Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
iCalUID string Specifies event ID in the iCalendar format to be included in the response. Optional.
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. 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:
  • "startTime": Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)
  • "updated": Order by last modification time (ascending).
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 any field, except for extended properties. Optional.
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:
  • iCalUID
  • orderBy
  • privateExtendedProperty
  • q
  • sharedExtendedProperty
  • timeMin
  • timeMax
  • updatedMin
If the 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.
timeMin datetime Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
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 RFC 3339 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.

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 RFC 3339 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:
  • "none" - The user has no access.
  • "freeBusyReader" - The user has read access to free/busy information.
  • "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
  • "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
  • "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
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:
  • "email" - Reminders are sent via email.
  • "sms" - Reminders are sent via SMS.
  • "popup" - Reminders are sent via a UI popup.
defaultReminders[].minutes integer Number of minutes before the start of the event when the reminder should trigger.
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.

String pageToken = null;
do {
  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
result = client.execute(:api_method => service.events.list,
                        :parameters => {'calendarId' => 'primary'})
while true
  events = result.data.items
  events.each do |e|
    print e.summary + "\n"
  end
  if !(page_token = result.data.next_page_token)
    break
  end
  result = client.execute(:api_method => service.events.list,
                          :parameters => {'calendarId' => 'primary',
                                          'pageToken' => page_token})
end

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.