Outlook Calendar: List Events with Pagination
See more Outlook Calendar Examples
List event records in the default calendar, or supply a calendar ID from List Calendars. The default path is /me/calendar/events; a named calendar uses /me/calendars/{id}/events. The ID is URL-encoded as a path segment. Least delegated permission for these selected fields: Calendars.ReadBasic.
This is not a date-range agenda. The events collection returns single-instance events and recurring-series masters; it does not expand every occurrence. For a day/week/month display, use calendarView with explicit start and end bounds. The Prefer: outlook.timezone="UTC" header controls returned start/end times; it does not change the stored event.
The example requests IdType="ImmutableId" for event IDs. Preserve their case and use the preference consistently on related requests. These IDs remain stable while an item stays in the same mailbox; they are not the same as iCalUId. Existing ordinary Graph IDs are a different ID format and should not be relabeled as immutable.
Follows each @odata.nextLink without editing its opaque query parameters. The example restricts continuation URLs to the configured Graph host, disables redirects, detects repeated links, and stops at a 100-page demonstration limit. Save the next URL privately to resume larger scans. A page can be empty and still have a next link.
Uses Microsoft Graph v1.0 in the global cloud with a delegated access token saved by the calendar OAuth2 example. Both personal Outlook.com accounts and Microsoft 365 work/school accounts with a mailbox can use this flow. The app registration must support the selected account type. A token for SMTP/IMAP/POP or another API is not a Graph token.
/me means the signed-in user and requires delegated authentication. An unattended Microsoft 365 service instead needs application permissions and administrator consent, and addresses an explicit mailbox through /users/{id-or-userPrincipalName}. That client-credentials flow does not apply to personal Outlook.com accounts. These samples target the global cloud; national clouds use different authority and Graph hosts.
HTTP methods can return false for an HTTP error as well as a connection failure. The code distinguishes those cases and checks the expected status before reading JSON. For 401, refresh the access token or authorize again; for 403, check permissions, mailbox access, and tenant policy. For 429, honor Retry-After before a bounded retry. Do not automatically repeat a write after an uncertain outcome. Keep detailed errors and calendar data private.
Chilkat Go Downloads
success := false
// Assumes Chilkat is unlocked. See Global Unlock Sample.
success = false
// Obtain a delegated Microsoft Graph token using the calendar authorization example.
// See Authorize Outlook Calendar with OAuth2 and PKCE.
token := chilkat.NewJsonObject()
token.SetStrict(true)
success = token.LoadFile("qa_data/tokens/outlookCalendar.json")
if success != true {
fmt.Println("Could not read the private calendar token cache.")
token.DisposeJsonObject()
return
}
if (token.JsonTypeOf("access_token") != 1) || (token.StringOfEquals("access_token","",true) == true) {
fmt.Println("Expected a nonempty access_token in the JSON.")
token.DisposeJsonObject()
return
}
http := chilkat.NewHttp()
http.SetAuthToken(token.StringOf("access_token"))
http.SetRequireSslCertVerify(true)
http.SetFollowRedirects(false)
http.SetConnectTimeout(20)
http.SetReadTimeout(30)
http.SetRequestHeader("Accept","application/json")
resp := chilkat.NewHttpResponse()
result := chilkat.NewJsonObject()
result.SetStrict(true)
http.SetRequestHeader("Prefer","outlook.timezone=\"UTC\", IdType=\"ImmutableId\"")
// Leave empty for the default calendar, or paste an ID returned by List Calendars.
calendarId := ""
eventUrl := chilkat.NewStringBuilder()
eventUrl.Append("https://graph.microsoft.com/v1.0/me/")
if calendarId == "" {
eventUrl.Append("calendar/events")
} else {
eventUrl.Append("calendars/")
eventUrl.Append(*http.UrlEncode(calendarId))
eventUrl.Append("/events")
}
eventUrl.Append("?$select=id,subject,start,end,type,isCancelled,showAs&$top=50")
url := eventUrl.GetAsString()
nextLink := chilkat.NewStringBuilder()
seenLinks := chilkat.NewStringArray()
pageCount := 0
for (pageCount < 100) {
// Use Microsoft's nextLink exactly as returned; do not rebuild skip tokens.
nextLink.Clear()
nextLink.Append(*url)
if nextLink.StartsWith("https://graph.microsoft.com/v1.0/",true) != true {
fmt.Println("Unexpected pagination host or API version; no request sent.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
eventUrl.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
if seenLinks.Find(*url,0) >= 0 {
fmt.Println("Repeated pagination URL; stopping.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
eventUrl.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
seenLinks.Append(*url)
success = http.HttpNoBody("GET",*url,resp)
// A false result can still include an HTTP error response.
if (success != true) && (resp.StatusCode() == 0) {
fmt.Println("No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
eventUrl.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
if resp.StatusCode() != 200 {
fmt.Println("Unexpected HTTP status: ", resp.StatusCode())
fmt.Println("Request ID: ", *resp.GetHeaderField("request-id"))
if resp.StatusCode() == 429 {
fmt.Println("Retry-After: ", *resp.GetHeaderField("Retry-After"))
}
if resp.StatusCode() == 401 {
fmt.Println("Refresh the Graph access token or authorize again.")
}
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
eventUrl.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
success = result.Load(resp.BodyStr())
if success != true {
fmt.Println("Expected a well-formed JSON response.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
eventUrl.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
if result.JsonTypeOf("value") != 4 {
fmt.Println("Expected a value array.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
eventUrl.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
i := 0
for (i < result.SizeOfArray("value")) {
result.SetI(i)
if (result.JsonTypeOf("value[i].id") != 1) || (result.StringOfEquals("value[i].id","",true) == true) {
fmt.Println("Expected a nonempty value[i].id in the JSON.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
eventUrl.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
fmt.Println("Event ID: ", *result.StringOf("value[i].id"))
fmt.Println("Subject: ", *result.StringOf("value[i].subject"))
fmt.Println("Start: ", *result.StringOf("value[i].start.dateTime"), " (", *result.StringOf("value[i].start.timeZone"), ")")
fmt.Println("End: ", *result.StringOf("value[i].end.dateTime"), " (", *result.StringOf("value[i].end.timeZone"), ")")
fmt.Println("Type: ", *result.StringOf("value[i].type"))
fmt.Println("Cancelled: ", *result.BoolOf("value[i].isCancelled"))
fmt.Println("Show as: ", *result.StringOf("value[i].showAs"))
i = i + 1
}
pageCount = pageCount + 1
// Quote the member name because @odata.nextLink contains a literal period.
nextType := result.JsonTypeOf("\"@odata.nextLink\"")
if (nextType == -1) || (nextType == 6) {
fmt.Println("Completed pages: ", pageCount)
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
eventUrl.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
if (nextType != 1) || (result.StringOfEquals("\"@odata.nextLink\"","",true) == true) {
fmt.Println("Invalid continuation link; cannot establish completeness.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
eventUrl.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
url = result.StringOf("\"@odata.nextLink\"")
}
fmt.Println("Stopped at the example's 100-page limit. Save the continuation URL privately to resume.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
eventUrl.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()