Outlook Calendar: List Calendars with Pagination
See more Outlook Calendar Examples
List calendars accessible through the signed-in user's /me/calendars collection and display the ID, name, default-calendar flag, editability, and owner. Save the calendar ID to select a particular calendar; names need not be unique. canEdit helps explain access but is not a substitute for authorization. A shared calendar must be available to the user; this is not an inventory of every mailbox in a tenant.
Least delegated permission: Calendars.ReadBasic. Calendar IDs are opaque, case-sensitive strings. Calendar containers already have stable IDs; the event-specific ImmutableId preference is unnecessary here.
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 SQL Server Downloads
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
DECLARE @iTmp1 int
DECLARE @sTmp0 nvarchar(4000)
DECLARE @success int
SELECT @success = 0
-- Assumes Chilkat is unlocked. See Global Unlock Sample.
SELECT @success = 0
-- Obtain a delegated Microsoft Graph token using the calendar authorization example.
-- See Authorize Outlook Calendar with OAuth2 and PKCE.
DECLARE @token int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @token OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
EXEC sp_OASetProperty @token, 'Strict', 1
EXEC sp_OAMethod @token, 'LoadFile', @success OUT, 'qa_data/tokens/outlookCalendar.json'
IF @success <> 1
BEGIN
PRINT 'Could not read the private calendar token cache.'
EXEC @hr = sp_OADestroy @token
RETURN
END
EXEC sp_OAMethod @token, 'JsonTypeOf', @iTmp0 OUT, 'access_token'
EXEC sp_OAMethod @token, 'StringOfEquals', @iTmp1 OUT, 'access_token', '', 1
IF (@iTmp0 <> 1) or (@iTmp1 = 1)
BEGIN
PRINT 'Expected a nonempty access_token in the JSON.'
EXEC @hr = sp_OADestroy @token
RETURN
END
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
EXEC sp_OAMethod @token, 'StringOf', @sTmp0 OUT, 'access_token'
EXEC sp_OASetProperty @http, 'AuthToken', @sTmp0
EXEC sp_OASetProperty @http, 'RequireSslCertVerify', 1
EXEC sp_OASetProperty @http, 'FollowRedirects', 0
EXEC sp_OASetProperty @http, 'ConnectTimeout', 20
EXEC sp_OASetProperty @http, 'ReadTimeout', 30
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT
DECLARE @result int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @result OUT
EXEC sp_OASetProperty @result, 'Strict', 1
DECLARE @url nvarchar(4000)
SELECT @url = 'https://graph.microsoft.com/v1.0/me/calendars?$select=id,name,isDefaultCalendar,canEdit,owner&$top=50'
DECLARE @nextLink int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @nextLink OUT
DECLARE @seenLinks int
EXEC @hr = sp_OACreate 'Chilkat.StringArray', @seenLinks OUT
DECLARE @pageCount int
SELECT @pageCount = 0
WHILE (@pageCount < 100)
BEGIN
-- Use Microsoft's nextLink exactly as returned; do not rebuild skip tokens.
EXEC sp_OAMethod @nextLink, 'Clear', NULL
EXEC sp_OAMethod @nextLink, 'Append', @success OUT, @url
EXEC sp_OAMethod @nextLink, 'StartsWith', @iTmp0 OUT, 'https://graph.microsoft.com/v1.0/', 1
IF @iTmp0 <> 1
BEGIN
PRINT 'Unexpected pagination host or API version; no request sent.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @result
EXEC @hr = sp_OADestroy @nextLink
EXEC @hr = sp_OADestroy @seenLinks
RETURN
END
EXEC sp_OAMethod @seenLinks, 'Find', @iTmp0 OUT, @url, 0
IF @iTmp0 >= 0
BEGIN
PRINT 'Repeated pagination URL; stopping.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @result
EXEC @hr = sp_OADestroy @nextLink
EXEC @hr = sp_OADestroy @seenLinks
RETURN
END
EXEC sp_OAMethod @seenLinks, 'Append', @success OUT, @url
EXEC sp_OAMethod @http, 'HttpNoBody', @success OUT, 'GET', @url, @resp
-- A false result can still include an HTTP error response.
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
IF (@success <> 1) and (@iTmp0 = 0)
BEGIN
PRINT 'No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @result
EXEC @hr = sp_OADestroy @nextLink
EXEC @hr = sp_OADestroy @seenLinks
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
IF @iTmp0 <> 200
BEGIN
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT 'Unexpected HTTP status: ' + @iTmp0
EXEC sp_OAMethod @resp, 'GetHeaderField', @sTmp0 OUT, 'request-id'
PRINT 'Request ID: ' + @sTmp0
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
IF @iTmp0 = 429
BEGIN
EXEC sp_OAMethod @resp, 'GetHeaderField', @sTmp0 OUT, 'Retry-After'
PRINT 'Retry-After: ' + @sTmp0
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
IF @iTmp0 = 401
BEGIN
PRINT 'Refresh the Graph access token or authorize again.'
END
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @result
EXEC @hr = sp_OADestroy @nextLink
EXEC @hr = sp_OADestroy @seenLinks
RETURN
END
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
EXEC sp_OAMethod @result, 'Load', @success OUT, @sTmp0
IF @success <> 1
BEGIN
PRINT 'Expected a well-formed JSON response.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @result
EXEC @hr = sp_OADestroy @nextLink
EXEC @hr = sp_OADestroy @seenLinks
RETURN
END
EXEC sp_OAMethod @result, 'JsonTypeOf', @iTmp0 OUT, 'value'
IF @iTmp0 <> 4
BEGIN
PRINT 'Expected a value array.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @result
EXEC @hr = sp_OADestroy @nextLink
EXEC @hr = sp_OADestroy @seenLinks
RETURN
END
DECLARE @i int
SELECT @i = 0
EXEC sp_OAMethod @result, 'SizeOfArray', @iTmp0 OUT, 'value'
WHILE (@i < @iTmp0)
BEGIN
EXEC sp_OASetProperty @result, 'I', @i
EXEC sp_OAMethod @result, 'JsonTypeOf', @iTmp0 OUT, 'value[i].id'
EXEC sp_OAMethod @result, 'StringOfEquals', @iTmp1 OUT, 'value[i].id', '', 1
IF (@iTmp0 <> 1) or (@iTmp1 = 1)
BEGIN
PRINT 'Expected a nonempty value[i].id in the JSON.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @result
EXEC @hr = sp_OADestroy @nextLink
EXEC @hr = sp_OADestroy @seenLinks
RETURN
END
EXEC sp_OAMethod @result, 'StringOf', @sTmp0 OUT, 'value[i].id'
PRINT 'Calendar ID: ' + @sTmp0
EXEC sp_OAMethod @result, 'StringOf', @sTmp0 OUT, 'value[i].name'
PRINT 'Name: ' + @sTmp0
EXEC sp_OAMethod @result, 'BoolOf', @iTmp0 OUT, 'value[i].isDefaultCalendar'
PRINT 'Default calendar: ' + @iTmp0
EXEC sp_OAMethod @result, 'BoolOf', @iTmp0 OUT, 'value[i].canEdit'
PRINT 'Can edit: ' + @iTmp0
EXEC sp_OAMethod @result, 'StringOf', @sTmp0 OUT, 'value[i].owner.address'
PRINT 'Owner: ' + @sTmp0
SELECT @i = @i + 1
END
SELECT @pageCount = @pageCount + 1
-- Quote the member name because @odata.nextLink contains a literal period.
DECLARE @nextType int
EXEC sp_OAMethod @result, 'JsonTypeOf', @nextType OUT, '"@odata.nextLink"'
IF (@nextType = -1) or (@nextType = 6)
BEGIN
PRINT 'Completed pages: ' + @pageCount
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @result
EXEC @hr = sp_OADestroy @nextLink
EXEC @hr = sp_OADestroy @seenLinks
RETURN
END
EXEC sp_OAMethod @result, 'StringOfEquals', @iTmp0 OUT, '"@odata.nextLink"', '', 1
IF (@nextType <> 1) or (@iTmp0 = 1)
BEGIN
PRINT 'Invalid continuation link; cannot establish completeness.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @result
EXEC @hr = sp_OADestroy @nextLink
EXEC @hr = sp_OADestroy @seenLinks
RETURN
END
EXEC sp_OAMethod @result, 'StringOf', @url OUT, '"@odata.nextLink"'
END
PRINT 'Stopped at the example''s 100-page limit. Save the continuation URL privately to resume.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @result
EXEC @hr = sp_OADestroy @nextLink
EXEC @hr = sp_OADestroy @seenLinks
END
GO