Events: instances

Returns instances of the specified recurring event. Try it now or see an example .

Request

HTTP request

GET https://www.googleapis.com/calendar/v3/calendars/ calendarId 
/events/ eventId 
/instances

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.
eventId
string
Recurring event identifier.
Optional query parameters
alwaysIncludeEmail
boolean
Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
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.
originalStart
string
The original start time of the instance in the result. Optional.
pageToken
string
Token specifying which result page to return. Optional.
showDeleted
boolean
Whether to include deleted events (with status equals " cancelled ") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.
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.
timeMin
datetime
Lower bound (inclusive) 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.
timeZone
string
Time zone used in the response. Optional. The default is the time zone of the calendar.

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:
  • " 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.
  • " popup " - Reminders are sent via a UI popup.

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 instances of a specific recurring event 
 String 
  
 pageToken 
  
 = 
  
 null 
 ; 
 do 
  
{  
 Events 
  
 events 
  
 = 
  
 service 
 . 
 events 
 (). 
 instances 
 ( 
 ' 
 primary 
 ' 
 , 
  
 ' 
 eventId 
 ' 
 ). 
 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 
 () 
 . 
 instances 
 ( 
 calendarId 
 = 
 'primary' 
 , 
 eventId 
 = 
 'eventId' 
 , 
 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->instances('primary', "eventId"); 
 while(true) 
{ foreach ($events->getItems() as $event) 
{ echo $event->getSummary(); 
  
} $pageToken = $events->getNextPageToken(); 
 if ($pageToken) 
{ $optParams = array('pageToken' => $pageToken); 
 $events = $service->events->instances('primary', "eventId", 
 $optParams); 
 } else 
{ break; 
  
}
}

Ruby

Uses the Ruby client library .

 page_token 
  
 = 
  
 nil 
 begin 
  
 result 
  
 = 
  
 client 
 . 
 list_event_instances 
 ( 
 'primary' 
 , 
  
 'eventId' 
 ) 
  
 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.