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 Unicode C++ Downloads
#include <CkJsonObjectW.h>
#include <CkHttpW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>
#include <CkStringArrayW.h>
void ChilkatSample(void)
{
bool 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.
CkJsonObjectW token;
token.put_Strict(true);
success = token.LoadFile(L"qa_data/tokens/outlookCalendar.json");
if (success != true) {
wprintf(L"Could not read the private calendar token cache.\n");
return;
}
if ((token.JsonTypeOf(L"access_token") != 1) || (token.StringOfEquals(L"access_token",L"",true) == true)) {
wprintf(L"Expected a nonempty access_token in the JSON.\n");
return;
}
CkHttpW http;
http.put_AuthToken(token.stringOf(L"access_token"));
http.put_RequireSslCertVerify(true);
http.put_FollowRedirects(false);
http.put_ConnectTimeout(20);
http.put_ReadTimeout(30);
http.SetRequestHeader(L"Accept",L"application/json");
CkHttpResponseW resp;
CkJsonObjectW result;
result.put_Strict(true);
http.SetRequestHeader(L"Prefer",L"outlook.timezone=\"UTC\", IdType=\"ImmutableId\"");
// Leave empty for the default calendar, or paste an ID returned by List Calendars.
const wchar_t *calendarId = L"";
CkStringBuilderW eventUrl;
eventUrl.Append(L"https://graph.microsoft.com/v1.0/me/");
if (calendarId == L"") {
eventUrl.Append(L"calendar/events");
}
else {
eventUrl.Append(L"calendars/");
eventUrl.Append(http.urlEncode(calendarId));
eventUrl.Append(L"/events");
}
eventUrl.Append(L"?$select=id,subject,start,end,type,isCancelled,showAs&$top=50");
const wchar_t *url = eventUrl.getAsString();
CkStringBuilderW nextLink;
CkStringArrayW seenLinks;
int pageCount = 0;
while ((pageCount < 100)) {
// Use Microsoft's nextLink exactly as returned; do not rebuild skip tokens.
nextLink.Clear();
nextLink.Append(url);
if (nextLink.StartsWith(L"https://graph.microsoft.com/v1.0/",true) != true) {
wprintf(L"Unexpected pagination host or API version; no request sent.\n");
return;
}
if (seenLinks.Find(url,0) >= 0) {
wprintf(L"Repeated pagination URL; stopping.\n");
return;
}
seenLinks.Append(url);
success = http.HttpNoBody(L"GET",url,resp);
// A false result can still include an HTTP error response.
if ((success != true) && (resp.get_StatusCode() == 0)) {
wprintf(L"No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying.\n");
return;
}
if (resp.get_StatusCode() != 200) {
wprintf(L"Unexpected HTTP status: %d\n",resp.get_StatusCode());
wprintf(L"Request ID: %s\n",resp.getHeaderField(L"request-id"));
if (resp.get_StatusCode() == 429) {
wprintf(L"Retry-After: %s\n",resp.getHeaderField(L"Retry-After"));
}
if (resp.get_StatusCode() == 401) {
wprintf(L"Refresh the Graph access token or authorize again.\n");
}
return;
}
success = result.Load(resp.bodyStr());
if (success != true) {
wprintf(L"Expected a well-formed JSON response.\n");
return;
}
if (result.JsonTypeOf(L"value") != 4) {
wprintf(L"Expected a value array.\n");
return;
}
int i = 0;
while ((i < result.SizeOfArray(L"value"))) {
result.put_I(i);
if ((result.JsonTypeOf(L"value[i].id") != 1) || (result.StringOfEquals(L"value[i].id",L"",true) == true)) {
wprintf(L"Expected a nonempty value[i].id in the JSON.\n");
return;
}
wprintf(L"Event ID: %s\n",result.stringOf(L"value[i].id"));
wprintf(L"Subject: %s\n",result.stringOf(L"value[i].subject"));
wprintf(L"Start: %s (%s)\n",result.stringOf(L"value[i].start.dateTime"),result.stringOf(L"value[i].start.timeZone"));
wprintf(L"End: %s (%s)\n",result.stringOf(L"value[i].end.dateTime"),result.stringOf(L"value[i].end.timeZone"));
wprintf(L"Type: %s\n",result.stringOf(L"value[i].type"));
wprintf(L"Cancelled: %d\n",result.BoolOf(L"value[i].isCancelled"));
wprintf(L"Show as: %s\n",result.stringOf(L"value[i].showAs"));
i = i + 1;
}
pageCount = pageCount + 1;
// Quote the member name because @odata.nextLink contains a literal period.
int nextType = result.JsonTypeOf(L"\"@odata.nextLink\"");
if ((nextType == -1) || (nextType == 6)) {
wprintf(L"Completed pages: %d\n",pageCount);
return;
}
if ((nextType != 1) || (result.StringOfEquals(L"\"@odata.nextLink\"",L"",true) == true)) {
wprintf(L"Invalid continuation link; cannot establish completeness.\n");
return;
}
url = result.stringOf(L"\"@odata.nextLink\"");
}
wprintf(L"Stopped at the example's 100-page limit. Save the continuation URL privately to resume.\n");
}