Outlook Calendar: Read a Date-Range Agenda with CalendarView
See more Outlook Calendar Examples
Read the next seven days from the default calendar, including recurring occurrences and exceptions. Query bounds carry explicit UTC offsets; the outlook.timezone preference changes response display, not the query window. To read another calendar, use /me/calendars/{id}/calendarView. Unlike /events, this is suitable for an agenda. Do not filter only on event start times when an event overlapping the window should appear.
Follow the complete @odata.nextLink, retain the same Prefer header on every page, and treat IDs as case-sensitive strings. The example checks the Graph host and repeated links, and has a 100-page demonstration limit. Save a continuation URL privately if a larger scan must resume.
Delegated permission: Calendars.ReadBasic.
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 C# Downloads
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.
Chilkat.JsonObject token = new Chilkat.JsonObject();
token.Strict = true;
success = token.LoadFile("qa_data/tokens/outlookCalendar.json");
if (success != true) {
Debug.WriteLine("Could not read the private calendar token cache.");
return;
}
if ((token.JsonTypeOf("access_token") != 1) || (token.StringOfEquals("access_token","",true) == true)) {
Debug.WriteLine("Expected a nonempty access_token in the JSON.");
return;
}
Chilkat.Http http = new Chilkat.Http();
http.AuthToken = token.StringOf("access_token");
http.RequireSslCertVerify = true;
http.FollowRedirects = false;
http.ConnectTimeout = 20;
http.ReadTimeout = 30;
http.SetRequestHeader("Accept","application/json");
Chilkat.HttpResponse resp = new Chilkat.HttpResponse();
Chilkat.JsonObject result = new Chilkat.JsonObject();
result.Strict = true;
http.SetRequestHeader("Prefer","outlook.timezone=\"UTC\", IdType=\"ImmutableId\"");
Chilkat.CkDateTime windowTime = new Chilkat.CkDateTime();
success = windowTime.SetFromCurrentSystemTime();
if (success != true) {
Debug.WriteLine("Could not get the current time.");
return;
}
string windowStart = windowTime.GetAsTimestamp(false);
success = windowTime.AddDays(7);
if (success != true) {
Debug.WriteLine("Could not calculate the window end.");
return;
}
string windowEnd = windowTime.GetAsTimestamp(false);
Chilkat.StringBuilder endpoint = new Chilkat.StringBuilder();
endpoint.Append("https://graph.microsoft.com/v1.0/me/calendarView?startDateTime=");
endpoint.Append(http.UrlEncode(windowStart));
endpoint.Append("&endDateTime=");
endpoint.Append(http.UrlEncode(windowEnd));
endpoint.Append("&$select=id,subject,start,end,type,seriesMasterId,isCancelled&$top=50");
string url = endpoint.GetAsString();
Chilkat.StringBuilder nextLink = new Chilkat.StringBuilder();
Chilkat.StringArray seenLinks = new Chilkat.StringArray();
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("https://graph.microsoft.com/v1.0/",true) != true) {
Debug.WriteLine("Unexpected pagination host or API version; no request sent.");
return;
}
if (seenLinks.Find(url,0) >= 0) {
Debug.WriteLine("Repeated pagination URL; stopping.");
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)) {
Debug.WriteLine("No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying.");
return;
}
if (resp.StatusCode != 200) {
Debug.WriteLine("Unexpected HTTP status: " + Convert.ToString(resp.StatusCode));
Debug.WriteLine("Request ID: " + resp.GetHeaderField("request-id"));
if (resp.StatusCode == 429) {
Debug.WriteLine("Retry-After: " + resp.GetHeaderField("Retry-After"));
}
if (resp.StatusCode == 401) {
Debug.WriteLine("Refresh the Graph access token or authorize again.");
}
return;
}
success = result.Load(resp.BodyStr);
if (success != true) {
Debug.WriteLine("Expected a well-formed JSON response.");
return;
}
if (result.JsonTypeOf("value") != 4) {
Debug.WriteLine("Expected a value array.");
return;
}
int i = 0;
while ((i < result.SizeOfArray("value"))) {
result.I = i;
if ((result.JsonTypeOf("value[i].id") != 1) || (result.StringOfEquals("value[i].id","",true) == true)) {
Debug.WriteLine("Expected a nonempty value[i].id in the JSON.");
return;
}
Debug.WriteLine("Event ID: " + result.StringOf("value[i].id"));
Debug.WriteLine("Subject: " + result.StringOf("value[i].subject"));
Debug.WriteLine("Start: " + result.StringOf("value[i].start.dateTime") + " (" + result.StringOf("value[i].start.timeZone") + ")");
Debug.WriteLine("End: " + result.StringOf("value[i].end.dateTime"));
Debug.WriteLine("Type: " + result.StringOf("value[i].type"));
i = i + 1;
}
pageCount = pageCount + 1;
// Quote the member name because @odata.nextLink contains a literal period.
int nextType = result.JsonTypeOf("\"@odata.nextLink\"");
if ((nextType == -1) || (nextType == 6)) {
Debug.WriteLine("Completed pages: " + Convert.ToString(pageCount));
return;
}
if ((nextType != 1) || (result.StringOfEquals("\"@odata.nextLink\"","",true) == true)) {
Debug.WriteLine("Invalid continuation link; cannot establish completeness.");
return;
}
url = result.StringOf("\"@odata.nextLink\"");
}
Debug.WriteLine("Stopped at the example's 100-page limit. Save the continuation URL privately to resume.");