Calendars.ReadBasic
Allows the app to read events in user calendars, except for properties such as body, attachments, and extensions.
Permission Details
Read basic details of user calendars
Allows the app to read events in user calendars, except for properties such as body, attachments, and extensions.
662d75ba-a364-42ad-adee-f5f880ea4878
Properties
Properties is shown from stable Microsoft Graph v1.0 metadata.
| Property | Type | Description |
|---|---|---|
allowedOnlineMeetingProviders |
onlineMeetingProviderType collection |
Represent the online meeting service providers that can be used to create online meetings in this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness. |
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 shared a calendar and granted write access. |
canShare |
BooleanNullable |
true if the user has permission to share the calendar, false otherwise. Only the user who created the calendar can share it. |
canViewPrivateItems |
BooleanNullable |
If true, the user can read calendar items that have been marked private, false otherwise. |
changeKey |
StringNullable |
Identifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only. |
color |
calendarColor |
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. |
defaultOnlineMeetingProvider |
onlineMeetingProviderType |
The default online meeting provider for meetings sent from this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness. |
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. Read-only. |
id |
String |
The calendar's unique identifier. Read-only. |
isDefaultCalendar |
BooleanNullable |
true if this is the default calendar where new events are created by default, false otherwise. |
isRemovable |
BooleanNullable |
Indicates whether this user calendar can be deleted from the user mailbox. |
isTallyingResponses |
BooleanNullable |
Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses. |
name |
StringNullable |
The calendar name. |
owner |
emailAddress |
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. |
calendarPermissions |
calendarPermission collection |
The permissions of the users with whom the calendar is shared. |
Showing 15 of 19 properties.
JSON Representation
JSON representation is shown from stable Microsoft Graph v1.0 metadata.
{
"allowedOnlineMeetingProviders": [
"string"
],
"canEdit": "boolean",
"canShare": "boolean",
"canViewPrivateItems": "boolean",
"changeKey": "string",
"color": "String",
"defaultOnlineMeetingProvider": "string",
"hexColor": "String",
"id": "string (identifier)",
"isDefaultCalendar": "boolean",
"isRemovable": "boolean",
"isTallyingResponses": "boolean",
"name": "string",
"owner": {
"@odata.type": "microsoft.graph.emailAddress"
}
}
Relationships
Relationships is shown from stable Microsoft Graph v1.0 metadata.
| Relationship | Type | Description |
|---|---|---|
calendarPermissions |
calendarPermission collection |
The permissions of the users with whom the calendar is shared. |
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. |
multiValueExtendedProperties |
multiValueLegacyExtendedProperty collection |
The collection of multi-value extended properties defined for the calendar. Read-only. Nullable. |
singleValueExtendedProperties |
singleValueLegacyExtendedProperty collection |
The collection of single-value extended properties defined for the calendar. Read-only. Nullable. |
allowedOnlineMeetingProviders |
array |
Represent the online meeting service providers that can be used to create online meetings in this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness. |
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. |
Graph Methods
Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.
Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.
Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.
Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.
Code Examples
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Me.Calendar.GetSchedule;
using Microsoft.Graph.Models;
var requestBody = new GetSchedulePostRequestBody
{
Schedules = new List<string>
{
"[email protected]",
"[email protected]",
},
StartTime = new DateTimeTimeZone
{
DateTime = "2019-03-15T09:00:00",
TimeZone = "Pacific Standard Time",
},
EndTime = new DateTimeTimeZone
{
DateTime = "2019-03-15T18:00:00",
TimeZone = "Pacific Standard Time",
},
AvailabilityViewInterval = 60,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Calendar.GetSchedule.PostAsGetSchedulePostResponseAsync(requestBody, (requestConfiguration) =>
{
requestConfiguration.Headers.Add("Prefer", "outlook.timezone=\"Pacific Standard Time\"");
});
const options = {
authProvider,
};
const client = Client.init(options);
const scheduleInformation = {
schedules: ['[email protected]', '[email protected]'],
startTime: {
dateTime: '2019-03-15T09:00:00',
timeZone: 'Pacific Standard Time'
},
endTime: {
dateTime: '2019-03-15T18:00:00',
timeZone: 'Pacific Standard Time'
},
availabilityViewInterval: 60
};
await client.api('/me/calendar/getSchedule')
.post(scheduleInformation);
Import-Module Microsoft.Graph.Calendar
# A UPN can also be used as -UserId.
Get-MgUserCalendarGroup -UserId $userId -CalendarGroupId $calendarGroupId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.users.item.calendar.get_schedule.get_schedule_request_builder import GetScheduleRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
from msgraph.generated.users.item.calendar.get_schedule.get_schedule_post_request_body import GetSchedulePostRequestBody
from msgraph.generated.models.date_time_time_zone import DateTimeTimeZone
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = GetSchedulePostRequestBody(
schedules = [
"[email protected]",
"[email protected]",
],
start_time = DateTimeTimeZone(
date_time = "2019-03-15T09:00:00",
time_zone = "Pacific Standard Time",
),
end_time = DateTimeTimeZone(
date_time = "2019-03-15T18:00:00",
time_zone = "Pacific Standard Time",
),
availability_view_interval = 60,
)
request_configuration = RequestConfiguration()
request_configuration.headers.add("Prefer", "outlook.timezone=\"Pacific Standard Time\"")
result = await graph_client.me.calendar.get_schedule.post(request_body, request_configuration = request_configuration)
App Registration
Navigate to Azure Portal
Go to App registrations in Microsoft Entra admin center
Add API Permission
Select your app → API permissions → Add a permission → Microsoft Graph
Select Permission Type
Choose Delegated permissions and search for Calendars.ReadBasic
Grant Admin Consent
Users can consent to this permission during sign-in.