ESC
Type to search...

Calendars.Read

Export JSON
Export CSV
Copy URL
Print
ApplicationDelegated Read User Scope

Allows the app to read events of all calendars without a signed-in user.

Delegated Access App-Only Access

Permission Details

Application Permission

Read calendars in all mailboxes

Allows the app to read events of all calendars without a signed-in user.

Delegated Permission User consent allowed

Read user calendars

Allows the app to read events in user calendars.

Properties

Property Type Description
id string The unique identifier for an entity. Read-only.
owner object If set, this represents the user who created or added the calendar. For a calendar that the user created or added, the owner property is set to the user. For a calendar shared with the user, the owner property is set to the person who shared that calendar with the user. Read-only.
multiValueExtendedProperties microsoft.graph.multiValueLegacyExtendedProperty collection The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.
canViewPrivateItems booleanNullable true if the user can read calendar items that have been marked private, false otherwise. This property is set through an Outlook client or the corresponding calendarPermission resource. Read-only.
name stringNullable The calendar name.
defaultOnlineMeetingProvider object The default online meeting provider for meetings sent from this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
calendarPermissions microsoft.graph.calendarPermission collection The permissions of the users with whom the calendar is shared.
color object Specifies the color theme to distinguish the calendar from other calendars in a UI. The property values are: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightRed, maxColor.
isRemovable booleanNullable Indicates whether this user calendar can be deleted from the user mailbox.
canEdit booleanNullable true if the user can write to the calendar, false otherwise. This property is true for the user who created the calendar. This property is also true for a user who has been shared a calendar and granted write access, through an Outlook client or the corresponding calendarPermission resource. Read-only.
singleValueExtendedProperties microsoft.graph.singleValueLegacyExtendedProperty collection The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
hexColor stringNullable The calendar color, expressed in a hex color code of three hexadecimal values, each ranging from 00 to FF and representing the red, green, or blue components of the color in the RGB color space. If the user has never explicitly set a color for the calendar, this property is empty.
events microsoft.graph.event collection The events in the calendar. Navigation property. Read-only.
canShare booleanNullable true if the user has the permission to share the calendar, false otherwise. Only the user who created the calendar can share it. Read-only.
isDefaultCalendar booleanNullable true if this is the default calendar where new events are created by default, false otherwise.

Showing 15 of 22 properties. View all on Microsoft Learn →

Relationships

Relationship Type Description
calendarView event collection The calendar view for the calendar. Navigation property. Read-only.
events event collection The events in the calendar. Navigation property. Read-only.
singleValueExtendedProperties singleValueExtendedProperties collection The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
multiValueExtendedProperties multiValueExtendedProperties collection The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.
calendarPermissions calendarPermission collection The permissions of the users with whom the calendar is shared.

Graph Methods

Delegated access App-only access
Methods
GET /devices/{Id}/extensions/{extensionId}
GET /groups/{id}/calendar
GET /groups/{id}/calendar/events
GET /groups/{id}/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /groups/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /groups/{Id}/events/{Id}/extensions/{extensionId}
GET /groups/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /groups/{Id}/extensions/{extensionId}
GET /groups/{Id}/threads/{Id}/posts/{Id}/extensions/{extensionId}
GET /me/calendar
GET /me/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendar/events
GET /me/calendar/events/{id}/attachments
GET /me/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendarGroups
GET /me/calendarGroups/{id}
GET /me/calendarGroups/{id}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendars
GET /me/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/events/{id}/attachments
GET /me/events/{id}/attachments/{id}
GET /me/events/{id}/attachments/{id}/$value
GET /me/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/mailFolders/{id}/messages/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /me/mailFolders/{id}/messages/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /me/messages/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /me/messages/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /me/settings/workHoursAndLocations
GET /me/settings/workHoursAndLocations/occurrencesView(startDateTime='{startDateTime}',endDateTime='{endDateTime}')
GET /me/settings/workHoursAndLocations/recurrences
GET /organization/{Id}/extensions/{extensionId}
GET /subscriptions
GET /subscriptions/{id}
GET /users/{id | userPrincipalName}/calendar
GET /users/{id | userPrincipalName}/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendar/events
GET /users/{id | userPrincipalName}/calendar/events/{id}/attachments
GET /users/{id | userPrincipalName}/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendarGroups
GET /users/{id | userPrincipalName}/calendarGroups/{id}
GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendars
GET /users/{id | userPrincipalName}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/events/{id}/attachments
GET /users/{id | userPrincipalName}/events/{id}/attachments/{id}
GET /users/{id | userPrincipalName}/events/{id}/attachments/{id}/$value
GET /users/{id | userPrincipalName}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/reminderView(startDateTime={startDateTime-value},endDateTime={endDateTime-value})
GET /users/{id}/calendar/calendarPermissions
GET /users/{id}/calendar/calendarPermissions/{id}
GET /users/{id}/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{Id|userPrincipalName}/contacts/{Id}/extensions/{extensionId}
GET /users/{Id|userPrincipalName}/events/{Id}/extensions/{extensionId}
GET /users/{Id|userPrincipalName}/extensions/{extensionId}
GET /users/{id|userPrincipalName}/messages/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/messages/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{Id|userPrincipalName}/messages/{Id}/extensions/{extensionId}
GET /users/{Id|userPrincipalName}/todo/lists/{todoTaskListId}/extensions/{extensionId}
GET /users/{Id|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{taskId}/extensions/{extensionId}
POST /groups/{id}/calendar/events/{id}/forward
POST /groups/{id}/events/{id}/forward
POST /me/calendar/events/{id}/forward
POST /me/calendar/getSchedule
POST /me/calendarGroups/{id}/calendars/{id}/events/{id}/forward
POST /me/calendars/{id}/events/{id}/forward
POST /me/events/{id}/forward
POST /search/query
POST /solutions/bookingBusinesses/{id}/getStaffAvailability
POST /subscriptions
POST /subscriptions/{subscriptionsId}/reauthorize
POST /users/{id | userPrincipalName}/calendar/events/{id}/forward
POST /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}/forward
POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/forward
POST /users/{id | userPrincipalName}/events/{id}/forward
POST /users/{id}/calendar/calendarPermissions
POST /users/{id|userPrincipalName}/calendar/getSchedule
PATCH /subscriptions/{id}
DELETE /subscriptions/{subscription-id}
Methods
GET /administrativeUnits/{administrativeUnitId}/extensions/{extensionId}
GET /devices/{deviceId}/extensions/{extensionId}
GET /drive/items/{itemId}/extensions/{extensionId}
GET /groups/{groupId}/events/{eventId}/extensions/{extensionId}
GET /groups/{groupId}/extensions/{extensionId}
GET /groups/{groupId}/threads/{threadId}/posts/{postId}/extensions/{extensionId}
GET /groups/{id}/calendar
GET /groups/{id}/calendar/events
GET /groups/{id}/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /groups/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /groups/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendar
GET /me/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendar/events
GET /me/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendarGroups
GET /me/calendarGroups/{id}
GET /me/calendarGroups/{id}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendars
GET /me/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendars/delta
GET /me/events/{id}/attachments
GET /me/events/{id}/attachments/{id}
GET /me/events/{id}/attachments/{id}/$value
GET /me/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/events/delta
GET /me/events/delta?startDateTime={start_datetime}
GET /me/mailFolders/{id}/messages/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /me/mailFolders/{id}/messages/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /me/messages/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /me/messages/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /me/settings/workHoursAndLocations
GET /me/settings/workHoursAndLocations/occurrencesView(startDateTime='{startDateTime}',endDateTime='{endDateTime}')
GET /me/settings/workHoursAndLocations/recurrences
GET /organization/{organizationId}/extensions/{extensionId}
GET /sites/{siteId}/extensions/{extensionId}
GET /subscriptions
GET /subscriptions/{id}
GET /subscriptions/getVapidPublicKey
GET /users/{id | userPrincipalName}/calendar
GET /users/{id | userPrincipalName}/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendar/events
GET /users/{id | userPrincipalName}/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendarGroups
GET /users/{id | userPrincipalName}/calendarGroups/{id}
GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendars
GET /users/{id | userPrincipalName}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/events/{id}/attachments/{id}
GET /users/{id | userPrincipalName}/events/{id}/attachments/{id}/$value
GET /users/{id | userPrincipalName}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/events/delta
GET /users/{id | userPrincipalName}/events/delta?startDateTime={start_datetime}
GET /users/{id | userPrincipalName}/reminderView(startDateTime={startDateTime},endDateTime={endDateTime})
GET /users/{id}/calendar/calendarPermissions
GET /users/{id}/calendar/calendarPermissions/{id}
GET /users/{Id|userPrincipalName}/events/{eventId}/extensions/{extensionId}
GET /users/{id|userPrincipalName}/events/{id}/attachments
GET /users/{id|userPrincipalName}/messages/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/messages/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{userId|userPrincipalName}/contacts/{contactId}/extensions/{extensionId}
GET /users/{userId|userPrincipalName}/extensions/{extensionId}
GET /users/{userId|userPrincipalName}/messages/{messageId}/extensions/{extensionId}
GET /users/{userId|userPrincipalName}/tasks/lists/{listId}/extensions/{extensionId}
GET /users/{userId|userPrincipalName}/tasks/lists/{listId}/tasks/{baseTaskId}/extensions/{extensionId}
GET /users/{userId|userPrincipalName}/todo/lists/{listId}/extensions/{extensionId}
GET /users/{userId|userPrincipalName}/todo/lists/{listId}/tasks/{todoTaskId}/extensions/{extensionId}
GET /users/{usersId}/calendars/delta
POST /groups/{id}/calendar/events/{id}/forward
POST /groups/{id}/events/{id}/forward
POST /me/calendar/events/{id}/forward
POST /me/calendar/getSchedule
POST /me/calendarGroups/{id}/calendars/{id}/events/{id}/forward
POST /me/calendars/{id}/events/{id}/forward
POST /me/events/{id}/forward
POST /search/query
POST /solutions/bookingbusinesses/{id}/getStaffAvailability
POST /subscriptions
POST /subscriptions/{subscriptionsId}/reauthorize
POST /users/{id | userPrincipalName}/calendar/events/{id}/forward
POST /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}/forward
POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/forward
POST /users/{id | userPrincipalName}/events/{id}/forward
POST /users/{id}/calendar/calendarPermissions
POST /users/{id|userPrincipalName}/calendar/getSchedule
PATCH /subscriptions/{id}
DELETE /subscriptions/{subscription-id}

Code Examples

C# / .NET SDK
// Install: dotnet add package Microsoft.Graph
// Install: dotnet add package Azure.Identity
using Microsoft.Graph;
using Azure.Identity;

// Delegated permissions - interactive user sign-in
var scopes = new[] { "Calendars.Read" };
var options = new InteractiveBrowserCredentialOptions
{
    ClientId = "YOUR_CLIENT_ID",
    TenantId = "YOUR_TENANT_ID",
    RedirectUri = new Uri("http://localhost")
};
var credential = new InteractiveBrowserCredential(options);
var graphClient = new GraphServiceClient(credential, scopes);

// Example: GET /me
var result = await graphClient.Me.GetAsync();
Console.WriteLine($"User: {result?.DisplayName}");

// Application permissions - daemon/service app
var tenantId = "YOUR_TENANT_ID";
var clientId = "YOUR_CLIENT_ID";
var clientSecret = "YOUR_CLIENT_SECRET";

var credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
var graphClient = new GraphServiceClient(credential);

// Example: GET /users/{user-id}
var users = await graphClient.Users.GetAsync();
foreach (var user in users?.Value ?? [])
{
    Console.WriteLine($"User: {user.DisplayName}");
}
JavaScript / TypeScript
// npm install @azure/msal-browser @microsoft/microsoft-graph-client
import { PublicClientApplication } from "@azure/msal-browser";
import { Client } from "@microsoft/microsoft-graph-client";
import { AuthCodeMSALBrowserAuthenticationProvider } from 
    "@microsoft/microsoft-graph-client/authProviders/authCodeMsalBrowser";

const msalConfig = {
    auth: {
        clientId: "YOUR_CLIENT_ID",
        authority: "https://login.microsoftonline.com/YOUR_TENANT_ID"
    }
};

const pca = new PublicClientApplication(msalConfig);
await pca.initialize();

// Delegated: Login with required scope
const loginResponse = await pca.loginPopup({
    scopes: ["Calendars.Read"]
});

const authProvider = new AuthCodeMSALBrowserAuthenticationProvider(pca, {
    account: loginResponse.account,
    scopes: ["Calendars.Read"],
    interactionType: "popup"
});

const graphClient = Client.initWithMiddleware({ authProvider });

// Example: GET /me
const result = await graphClient.api("/me").get();
console.log(result);

// Application: Use client credentials (Node.js backend only)
// npm install @azure/identity @microsoft/microsoft-graph-client
import { ClientSecretCredential } from "@azure/identity";
import { TokenCredentialAuthenticationProvider } from 
    "@microsoft/microsoft-graph-client/authProviders/azureTokenCredentials";

const credential = new ClientSecretCredential(
    "YOUR_TENANT_ID",
    "YOUR_CLIENT_ID", 
    "YOUR_CLIENT_SECRET"
);

const authProvider = new TokenCredentialAuthenticationProvider(credential, {
    scopes: ["https://graph.microsoft.com/.default"]
});

const graphClient = Client.initWithMiddleware({ authProvider });
const result = await graphClient.api("/users").get();
console.log(result);
PowerShell
# Install Microsoft Graph PowerShell module
Install-Module Microsoft.Graph -Scope CurrentUser

# Delegated access - interactive sign-in
Connect-MgGraph -Scopes "Calendars.Read"

# Verify connection
Get-MgContext | Select-Object Account, TenantId, Scopes

# Example: GET /me
$result = Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/me"
$result | ConvertTo-Json -Depth 5

# Application access with certificate
$params = @{
    ClientId = "YOUR_CLIENT_ID"
    TenantId = "YOUR_TENANT_ID"
    CertificateThumbprint = "YOUR_CERT_THUMBPRINT"
}
Connect-MgGraph @params

# Or with client secret (not recommended for production)
# Connect-MgGraph -ClientSecretCredential $credential

# Example: GET /users
$result = Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/users"
$result | ConvertTo-Json -Depth 5

# Always disconnect when done
Disconnect-MgGraph
Python
# pip install msgraph-sdk azure-identity
from azure.identity import InteractiveBrowserCredential, ClientSecretCredential
from msgraph import GraphServiceClient
import asyncio

# Delegated permissions - interactive browser sign-in
credential = InteractiveBrowserCredential(
    client_id="YOUR_CLIENT_ID",
    tenant_id="YOUR_TENANT_ID"
)
scopes = ["Calendars.Read"]
client = GraphServiceClient(credential, scopes)

async def get_data():
    # Example: GET /me
    result = await client.me.get()
    print(f"User: {result.display_name}")
    return result

asyncio.run(get_data())

# Application permissions - client credentials
credential = ClientSecretCredential(
    tenant_id="YOUR_TENANT_ID",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET"
)
scopes = ["https://graph.microsoft.com/.default"]
client = GraphServiceClient(credential, scopes)

async def get_users():
    # Example: GET /users
    result = await client.users.get()
    for user in result.value:
        print(f"User: {user.display_name}")
    return result

asyncio.run(get_users())

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Application permissions or Delegated permissions and search for Calendars.Read

4

Grant Admin Consent

Application permissions always require admin consent. Click "Grant admin consent" in the Azure portal.