Sample code for 30+ languages & platforms
Visual Basic 6.0 Requires Chilkat v11.6.0+

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.

Microsoft documentation

Chilkat Visual Basic 6.0 Downloads

Visual Basic 6.0
Dim success As Long
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.
Dim token As New ChilkatJsonObject
token.Strict = 1
success = token.LoadFile("qa_data/tokens/outlookCalendar.json")
If (success <> 1) Then
    Debug.Print "Could not read the private calendar token cache."
    Exit Sub
End If

If ((token.JsonTypeOf("access_token") <> 1) Or (token.StringOfEquals("access_token","",1) = 1)) Then
    Debug.Print "Expected a nonempty access_token in the JSON."
    Exit Sub
End If

Dim http As New ChilkatHttp
http.AuthToken = token.StringOf("access_token")
http.RequireSslCertVerify = 1
http.FollowRedirects = 0
http.ConnectTimeout = 20
http.ReadTimeout = 30
http.SetRequestHeader "Accept","application/json"
Dim resp As New ChilkatHttpResponse
Dim result As New ChilkatJsonObject
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.
Dim calendarId As String
calendarId = ""
Dim eventUrl As New ChilkatStringBuilder
success = eventUrl.Append("https://graph.microsoft.com/v1.0/me/")
If (calendarId = "") Then
    success = eventUrl.Append("calendar/events")
Else
    success = eventUrl.Append("calendars/")
    success = eventUrl.Append(http.UrlEncode(calendarId))
    success = eventUrl.Append("/events")
End If

success = eventUrl.Append("?$select=id,subject,start,end,type,isCancelled,showAs&$top=50")
Dim url As String
url = eventUrl.GetAsString()
Dim nextLink As New ChilkatStringBuilder
Dim seenLinks As New CkStringArray
Dim pageCount As Long
pageCount = 0
Do While (pageCount < 100)
    '  Use Microsoft's nextLink exactly as returned; do not rebuild skip tokens.
    nextLink.Clear 
    success = nextLink.Append(url)
    If (nextLink.StartsWith("https://graph.microsoft.com/v1.0/",1) <> 1) Then
        Debug.Print "Unexpected pagination host or API version; no request sent."
        Exit Sub
    End If

    If (seenLinks.Find(url,0) >= 0) Then
        Debug.Print "Repeated pagination URL; stopping."
        Exit Sub
    End If

    success = 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)) Then
        Debug.Print "No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying."
        Exit Sub
    End If

    If (resp.StatusCode <> 200) Then
        Debug.Print "Unexpected HTTP status: " & resp.StatusCode
        Debug.Print "Request ID: " & resp.GetHeaderField("request-id")
        If (resp.StatusCode = 429) Then
            Debug.Print "Retry-After: " & resp.GetHeaderField("Retry-After")
        End If

        If (resp.StatusCode = 401) Then
            Debug.Print "Refresh the Graph access token or authorize again."
        End If

        Exit Sub
    End If

    success = result.Load(resp.BodyStr)
    If (success <> 1) Then
        Debug.Print "Expected a well-formed JSON response."
        Exit Sub
    End If

    If (result.JsonTypeOf("value") <> 4) Then
        Debug.Print "Expected a value array."
        Exit Sub
    End If

    Dim i As Long
    i = 0
    Do While (i < result.SizeOfArray("value"))
        result.I = i
        If ((result.JsonTypeOf("value[i].id") <> 1) Or (result.StringOfEquals("value[i].id","",1) = 1)) Then
            Debug.Print "Expected a nonempty value[i].id in the JSON."
            Exit Sub
        End If

        Debug.Print "Event ID: " & result.StringOf("value[i].id")
        Debug.Print "Subject: " & result.StringOf("value[i].subject")
        Debug.Print "Start: " & result.StringOf("value[i].start.dateTime") & " (" & result.StringOf("value[i].start.timeZone") & ")"
        Debug.Print "End: " & result.StringOf("value[i].end.dateTime") & " (" & result.StringOf("value[i].end.timeZone") & ")"
        Debug.Print "Type: " & result.StringOf("value[i].type")
        Debug.Print "Cancelled: " & result.BoolOf("value[i].isCancelled")
        Debug.Print "Show as: " & result.StringOf("value[i].showAs")
        i = i + 1
    Loop
    pageCount = pageCount + 1
    '  Quote the member name because @odata.nextLink contains a literal period.
    Dim nextType As Long
    nextType = result.JsonTypeOf("""@odata.nextLink""")
    If ((nextType = -1) Or (nextType = 6)) Then
        Debug.Print "Completed pages: " & pageCount
        Exit Sub
    End If

    If ((nextType <> 1) Or (result.StringOfEquals("""@odata.nextLink""","",1) = 1)) Then
        Debug.Print "Invalid continuation link; cannot establish completeness."
        Exit Sub
    End If

    url = result.StringOf("""@odata.nextLink""")
Loop
Debug.Print "Stopped at the example's 100-page limit. Save the continuation URL privately to resume."