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 PowerBuilder Downloads
integer li_rc
long li_Success
oleobject loo_Token
oleobject loo_Http
oleobject loo_Resp
oleobject loo_Result
string ls_CalendarId
oleobject loo_EventUrl
string ls_Url
oleobject loo_NextLink
oleobject loo_SeenLinks
long li_PageCount
long i
long li_NextType
li_Success = 0
// Assumes Chilkat is unlocked. See Global Unlock Sample.
li_Success = 0
// Obtain a delegated Microsoft Graph token using the calendar authorization example.
// See Authorize Outlook Calendar with OAuth2 and PKCE.
loo_Token = create oleobject
li_rc = loo_Token.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
destroy loo_Token
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Token.Strict = 1
li_Success = loo_Token.LoadFile("qa_data/tokens/outlookCalendar.json")
if li_Success <> 1 then
Write-Debug "Could not read the private calendar token cache."
destroy loo_Token
return
end if
if (loo_Token.JsonTypeOf("access_token") <> 1) OR (loo_Token.StringOfEquals("access_token","",1) = 1) then
Write-Debug "Expected a nonempty access_token in the JSON."
destroy loo_Token
return
end if
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
loo_Http.AuthToken = loo_Token.StringOf("access_token")
loo_Http.RequireSslCertVerify = 1
loo_Http.FollowRedirects = 0
loo_Http.ConnectTimeout = 20
loo_Http.ReadTimeout = 30
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = create oleobject
li_rc = loo_Resp.ConnectToNewObject("Chilkat.HttpResponse")
loo_Result = create oleobject
li_rc = loo_Result.ConnectToNewObject("Chilkat.JsonObject")
loo_Result.Strict = 1
loo_Http.SetRequestHeader("Prefer","outlook.timezone=~"UTC~", IdType=~"ImmutableId~"")
// Leave empty for the default calendar, or paste an ID returned by List Calendars.
ls_CalendarId = ""
loo_EventUrl = create oleobject
li_rc = loo_EventUrl.ConnectToNewObject("Chilkat.StringBuilder")
loo_EventUrl.Append("https://graph.microsoft.com/v1.0/me/")
if ls_CalendarId = "" then
loo_EventUrl.Append("calendar/events")
else
loo_EventUrl.Append("calendars/")
loo_EventUrl.Append(loo_Http.UrlEncode(ls_CalendarId))
loo_EventUrl.Append("/events")
end if
loo_EventUrl.Append("?$select=id,subject,start,end,type,isCancelled,showAs&$top=50")
ls_Url = loo_EventUrl.GetAsString()
loo_NextLink = create oleobject
li_rc = loo_NextLink.ConnectToNewObject("Chilkat.StringBuilder")
loo_SeenLinks = create oleobject
li_rc = loo_SeenLinks.ConnectToNewObject("Chilkat.StringArray")
li_PageCount = 0
do while (li_PageCount < 100)
// Use Microsoft's nextLink exactly as returned; do not rebuild skip tokens.
loo_NextLink.Clear()
loo_NextLink.Append(ls_Url)
if loo_NextLink.StartsWith("https://graph.microsoft.com/v1.0/",1) <> 1 then
Write-Debug "Unexpected pagination host or API version; no request sent."
destroy loo_Token
destroy loo_Http
destroy loo_Resp
destroy loo_Result
destroy loo_EventUrl
destroy loo_NextLink
destroy loo_SeenLinks
return
end if
if loo_SeenLinks.Find(ls_Url,0) >= 0 then
Write-Debug "Repeated pagination URL; stopping."
destroy loo_Token
destroy loo_Http
destroy loo_Resp
destroy loo_Result
destroy loo_EventUrl
destroy loo_NextLink
destroy loo_SeenLinks
return
end if
loo_SeenLinks.Append(ls_Url)
li_Success = loo_Http.HttpNoBody("GET",ls_Url,loo_Resp)
// A false result can still include an HTTP error response.
if (li_Success <> 1) AND (loo_Resp.StatusCode = 0) then
Write-Debug "No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying."
destroy loo_Token
destroy loo_Http
destroy loo_Resp
destroy loo_Result
destroy loo_EventUrl
destroy loo_NextLink
destroy loo_SeenLinks
return
end if
if loo_Resp.StatusCode <> 200 then
Write-Debug "Unexpected HTTP status: " + string(loo_Resp.StatusCode)
Write-Debug "Request ID: " + loo_Resp.GetHeaderField("request-id")
if loo_Resp.StatusCode = 429 then
Write-Debug "Retry-After: " + loo_Resp.GetHeaderField("Retry-After")
end if
if loo_Resp.StatusCode = 401 then
Write-Debug "Refresh the Graph access token or authorize again."
end if
destroy loo_Token
destroy loo_Http
destroy loo_Resp
destroy loo_Result
destroy loo_EventUrl
destroy loo_NextLink
destroy loo_SeenLinks
return
end if
li_Success = loo_Result.Load(loo_Resp.BodyStr)
if li_Success <> 1 then
Write-Debug "Expected a well-formed JSON response."
destroy loo_Token
destroy loo_Http
destroy loo_Resp
destroy loo_Result
destroy loo_EventUrl
destroy loo_NextLink
destroy loo_SeenLinks
return
end if
if loo_Result.JsonTypeOf("value") <> 4 then
Write-Debug "Expected a value array."
destroy loo_Token
destroy loo_Http
destroy loo_Resp
destroy loo_Result
destroy loo_EventUrl
destroy loo_NextLink
destroy loo_SeenLinks
return
end if
i = 0
do while (i < loo_Result.SizeOfArray("value"))
loo_Result.I = i
if (loo_Result.JsonTypeOf("value[i].id") <> 1) OR (loo_Result.StringOfEquals("value[i].id","",1) = 1) then
Write-Debug "Expected a nonempty value[i].id in the JSON."
destroy loo_Token
destroy loo_Http
destroy loo_Resp
destroy loo_Result
destroy loo_EventUrl
destroy loo_NextLink
destroy loo_SeenLinks
return
end if
Write-Debug "Event ID: " + loo_Result.StringOf("value[i].id")
Write-Debug "Subject: " + loo_Result.StringOf("value[i].subject")
Write-Debug "Start: " + loo_Result.StringOf("value[i].start.dateTime") + " (" + loo_Result.StringOf("value[i].start.timeZone") + ")"
Write-Debug "End: " + loo_Result.StringOf("value[i].end.dateTime") + " (" + loo_Result.StringOf("value[i].end.timeZone") + ")"
Write-Debug "Type: " + loo_Result.StringOf("value[i].type")
Write-Debug "Cancelled: " + string(loo_Result.BoolOf("value[i].isCancelled"))
Write-Debug "Show as: " + loo_Result.StringOf("value[i].showAs")
i = i + 1
loop
li_PageCount = li_PageCount + 1
// Quote the member name because @odata.nextLink contains a literal period.
li_NextType = loo_Result.JsonTypeOf("~"@odata.nextLink~"")
if (li_NextType = -1) OR (li_NextType = 6) then
Write-Debug "Completed pages: " + string(li_PageCount)
destroy loo_Token
destroy loo_Http
destroy loo_Resp
destroy loo_Result
destroy loo_EventUrl
destroy loo_NextLink
destroy loo_SeenLinks
return
end if
if (li_NextType <> 1) OR (loo_Result.StringOfEquals("~"@odata.nextLink~"","",1) = 1) then
Write-Debug "Invalid continuation link; cannot establish completeness."
destroy loo_Token
destroy loo_Http
destroy loo_Resp
destroy loo_Result
destroy loo_EventUrl
destroy loo_NextLink
destroy loo_SeenLinks
return
end if
ls_Url = loo_Result.StringOf("~"@odata.nextLink~"")
loop
Write-Debug "Stopped at the example's 100-page limit. Save the continuation URL privately to resume."
destroy loo_Token
destroy loo_Http
destroy loo_Resp
destroy loo_Result
destroy loo_EventUrl
destroy loo_NextLink
destroy loo_SeenLinks