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 PHP ActiveX Downloads
<?php
$success = 0;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
$success = 0;
// Obtain a delegated Microsoft Graph token using the calendar authorization example.
// See Authorize Outlook Calendar with OAuth2 and PKCE.
$token = new COM("Chilkat.JsonObject");
$token->Strict = 1;
$success = $token->LoadFile('qa_data/tokens/outlookCalendar.json');
if ($success != 1) {
print 'Could not read the private calendar token cache.' . "\n";
exit;
}
if (($token->JsonTypeOf('access_token') != 1) or ($token->StringOfEquals('access_token','',1) == 1)) {
print 'Expected a nonempty access_token in the JSON.' . "\n";
exit;
}
$http = new COM("Chilkat.Http");
$http->AuthToken = $token->stringOf('access_token');
$http->RequireSslCertVerify = 1;
$http->FollowRedirects = 0;
$http->ConnectTimeout = 20;
$http->ReadTimeout = 30;
$http->SetRequestHeader('Accept','application/json');
$resp = new COM("Chilkat.HttpResponse");
$result = new COM("Chilkat.JsonObject");
$result->Strict = 1;
$http->SetRequestHeader('Prefer','outlook.timezone=\'UTC\', IdType=\'ImmutableId\'');
// Leave empty for the default calendar, or paste an ID returned by List Calendars.
$calendarId = '';
$eventUrl = new COM("Chilkat.StringBuilder");
$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 = new COM("Chilkat.StringBuilder");
$seenLinks = new COM("Chilkat.StringArray");
$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('https://graph.microsoft.com/v1.0/',1) != 1) {
print 'Unexpected pagination host or API version; no request sent.' . "\n";
exit;
}
if ($seenLinks->Find($url,0) >= 0) {
print 'Repeated pagination URL; stopping.' . "\n";
exit;
}
$seenLinks->Append($url);
$success = $http->HttpNoBody('GET',$url,$resp);
// A false result can still include an HTTP error response.
if (($success != 1) and ($resp->StatusCode == 0)) {
print 'No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying.' . "\n";
exit;
}
if ($resp->StatusCode != 200) {
print 'Unexpected HTTP status: ' . $resp->StatusCode . "\n";
print 'Request ID: ' . $resp->getHeaderField('request-id') . "\n";
if ($resp->StatusCode == 429) {
print 'Retry-After: ' . $resp->getHeaderField('Retry-After') . "\n";
}
if ($resp->StatusCode == 401) {
print 'Refresh the Graph access token or authorize again.' . "\n";
}
exit;
}
$success = $result->Load($resp->BodyStr);
if ($success != 1) {
print 'Expected a well-formed JSON response.' . "\n";
exit;
}
if ($result->JsonTypeOf('value') != 4) {
print 'Expected a value array.' . "\n";
exit;
}
$i = 0;
while (($i < $result->SizeOfArray('value'))) {
$result->I = $i;
if (($result->JsonTypeOf('value[i].id') != 1) or ($result->StringOfEquals('value[i].id','',1) == 1)) {
print 'Expected a nonempty value[i].id in the JSON.' . "\n";
exit;
}
print 'Event ID: ' . $result->stringOf('value[i].id') . "\n";
print 'Subject: ' . $result->stringOf('value[i].subject') . "\n";
print 'Start: ' . $result->stringOf('value[i].start.dateTime') . ' (' . $result->stringOf('value[i].start.timeZone') . ')' . "\n";
print 'End: ' . $result->stringOf('value[i].end.dateTime') . ' (' . $result->stringOf('value[i].end.timeZone') . ')' . "\n";
print 'Type: ' . $result->stringOf('value[i].type') . "\n";
print 'Cancelled: ' . $result->BoolOf('value[i].isCancelled') . "\n";
print 'Show as: ' . $result->stringOf('value[i].showAs') . "\n";
$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) or ($nextType == 6)) {
print 'Completed pages: ' . $pageCount . "\n";
exit;
}
if (($nextType != 1) or ($result->StringOfEquals('\'@odata.nextLink\'','',1) == 1)) {
print 'Invalid continuation link; cannot establish completeness.' . "\n";
exit;
}
$url = $result->stringOf('\'@odata.nextLink\'');
}
print 'Stopped at the example's 100-page limit. Save the continuation URL privately to resume.' . "\n";
?>