Calendars.Read

Allows the app to read events in user calendars .

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver	Type	Method
V1	A,D	GET /groups/{id}/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /groups/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /me/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /me/calendar/events/{id}/attachments
V1	A,D	GET /me/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /me/calendarGroups
V1	A,D	GET /me/calendarGroups/{id}
V1	A,D	GET /me/calendargroups/{id}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /me/calendars
V1	A,D	GET /me/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /me/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /me/events/{id}/attachments
V1	A,D	GET /me/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /me/events/delta
V1	A,D	GET /me/events/delta?startDateTime={start_datetime}
V1	A,D	GET /users/{id | userPrincipalName}/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /users/{id | userPrincipalName}/calendar/events/{id}/attachments
V1	A,D	GET /users/{id | userPrincipalName}/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /users/{id | userPrincipalName}/calendarGroups
V1	A,D	GET /users/{id | userPrincipalName}/calendarGroups/{id}
V1	A,D	GET /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /users/{id | userPrincipalName}/calendars
V1	A,D	GET /users/{id | userPrincipalName}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /users/{id | userPrincipalName}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /users/{id | userPrincipalName}/events/{id}/attachments
V1	A,D	GET /users/{id | userPrincipalName}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /users/{id | userPrincipalName}/events/delta
V1	A,D	GET /users/{id | userPrincipalName}/events/delta?startDateTime={start_datetime}
V1	A,D	GET /users/{id | userPrincipalName}/reminderView(startDateTime=startDateTime-value,endDateTime=endDateTime-value)
V1	A,D	GET /users/{id}/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}
V1	A,D	GET /users/{id|userPrincipalName}/events/{id}/attachments
V1	A,D	POST /groups/{id}/calendar/events/{id}/forward
V1	A,D	POST /groups/{id}/events/{id}/forward
V1	A,D	POST /me/calendar/events/{id}/forward
V1	A,D	POST /me/calendar/getSchedule
V1	A,D	POST /me/calendar/getSchedule
V1	A,D	POST /me/calendargroups/{id}/calendars/{id}/events/{id}/forward
V1	A,D	POST /me/calendars/{id}/events/{id}/forward
V1	A,D	POST /me/events/{id}/forward
V1	D	POST /search/query
V1	A,D	POST /users/{id | userPrincipalName}/calendar/events/{id}/forward
V1	A,D	POST /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/forward
V1	A,D	POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/forward
V1	A,D	POST /users/{id | userPrincipalName}/events/{id}/forward
V1	A,D	POST /users/{id|userPrincipalName}/calendar/getSchedule
V1	A,D	Prefer: outlook.timezone="Eastern Standard Time"

Delegate Permission

Id	465a38f9-76ea-45b9-9f34-9e8b0d4b0b42
Consent Type	User
Display String	Read user calendars
Description	Allows the app to read events in user calendars .

Application Permission

Id	798ee544-9d2d-430c-a058-570e29e34338
Display String	Read calendars in all mailboxes
Description	Allows the app to read events of all calendars without a signed-in user.

Resources

attachment

Property	Type	Description
contentType	String	The MIME type.
id	String	Read-only.
isInline	Boolean	true if the attachment is an inline attachment; otherwise, false.
lastModifiedDateTime	DateTimeOffset	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
name	String	The attachment's file name.
size	Int32	The length of the attachment in bytes.

calendar

Property	Type	Description
allowedOnlineMeetingProviders	onlineMeetingProviderType collection	Represent the online meeting service providers that can be used to create online meetings in this calendar. Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
canEdit	Boolean	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.
canShare	Boolean	true if the user has the permission to share the calendar, false otherwise. Only the user who created the calendar can share it.
canViewPrivateItems	Boolean	true if the user can read calendar items that have been marked private, false otherwise.
changeKey	String	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. Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
hexColor	String	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	Boolean	true if this is the default calendar where new events are created by default, false otherwise.
isRemovable	Boolean	Indicates whether this user calendar can be deleted from the user mailbox.
isTallyingResponses	Boolean	Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.
name	String	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 **o

calendarGroup

Property	Type	Description
name	String	The group name.
changeKey	String	Identifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.
classId	Guid	The class identifier. Read-only.
id	String	The group's unique identifier. Read-only.

dateTimeTimeZone

Property	Type	Description
dateTime	String	A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
timeZone	String	Represents a time zone, for example, "Pacific Standard Time". See below for more possible values.

event

Property	Type	Description
allowNewTimeProposals	Boolean	true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. Default is true.
attendees	Attendee collection	The collection of attendees for the event.
body	ItemBody	The body of the message associated with the event. It can be in HTML or text format.
bodyPreview	String	The preview of the message associated with the event. It is in text format.
categories	String collection	The categories associated with the event. Each category corresponds to the displayName property of an outlookCategory defined for the user.
changeKey	String	Identifies the version of the event object. Every time the event is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object.
createdDateTime	DateTimeOffset	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
end	DateTimeTimeZone	The date, time, and time zone that the event ends. By default, the end time is in UTC.
hasAttachments	Boolean	Set to true if the event has attachments.
hideAttendees	Boolean	When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.
iCalUId	String	A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.
id	String	Unique identifier for the event. !INCLUDE [outlook-beta-id] Case-sensitive and read-only.
importance	String	The importance of the event. The possible values are: low, normal, high.
isAllDay	Boolean	Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.
isCancelled	Boolean	Set to true if the event has been canceled.
isDraft	Boolean	Set to true if the user has updated the meeting in Outlook but has not sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.
isOnlineMeeting	Boolean	True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Subsequently Outlook ignores any further changes to isOnlineMeeting, and the meeting remains available online.
isOrganizer	Boolean	Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). This also applies if a delegate organized the event on behalf of the owner.
isReminderOn	Boolean	Set to true if an alert is set to remind the user of the event.
lastModifiedDateTime	DateTimeOffset	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
location	Location	The location of the event.
locations	Location collection	The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.
onlineMeeting	OnlineMeetingInfo	Details for an attendee to join the meeting online. Default is null. Read-only. After you set the isOnlineMeeting and onlineMeetingProvider properties to enable a meeting online, Microsoft Graph initializes onlineMeeting. When set, the meeting remains available online, and you cannot change the isOnlineMeeting, onlineMeetingProvider, and onlneMeeting properties again.
onlineMeetingProvider	onlineMeetingProviderType	Represents the online meeting service provider. By default, onlineMeetingProvider is unknown. The possible values are unknown, teamsForBusiness, skypeForBusiness, and skypeForConsumer. Optional. After you set onlineMeetingProvider, Microsoft Graph initializes onlineMeeting. Subsequently you cannot change onlineMeetingProvider again, and the meeting remains available online.
onlineMeetingUrl	String	A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only. To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.
organizer	Recipient	The organizer of the event.
originalEndTimeZone	String	The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
originalStart	DateTimeOffset	Represents the start time of an event when it is initially created as an occurrence or exception in a recurring series. This property is not returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
originalStartTimeZone	String	The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
recurrence	PatternedRecurrence	The recurrence pattern for the event.
reminderMinutesBeforeStart	Int32	The number of minutes before the event start time that the reminder alert occurs.
responseRequested	Boolean	Default is true, which represents the organizer would like an invitee to send a response to the event.
responseStatus	ResponseStatus	Indicates the type of response sent in response to an event message.
sensitivity	String	Possible values are: normal, personal, private, confidential.
seriesMasterId	String	The ID for the recurring series master item, if this event is part of a recurring series.
showAs	String	The status to show. Possible values are: free, tentative, busy, oof, workingElsewhere, unknown.
start	DateTimeTimeZone	The start date, time, and time zone of the event. By default, the start time is in UTC.
subject	String	The text of the event's subject line.
transactionId	String	A custom identifier specified by a client app for the server to avoid redundant POST operations in case of client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you cannot change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.
type	String	The event type. Possible values are: singleInstance, occurrence, exception, seriesMaster. Read-only
webLink	String	The URL to open the event in Outlook on the web. Outlook on the web opens the event in the browser if you are signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in. This URL cannot be accessed from within an iFrame.

recipient

Property	Type	Description
emailAddress	EmailAddress	The recipient's email address.

reminder

Property	Type	Description
changeKey	String	Identifies the version of the reminder. Every time the reminder is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object.
eventEndTime	DateTimeTimeZone	The date, time and time zone that the event ends.
eventId	String	The unique ID of the event. Read only.
eventLocation	Location	The location of the event.
eventStartTime	DateTimeTimeZone	The date, time, and time zone that the event starts.
eventSubject	String	The text of the event's subject line.
eventWebLink	String	The URL to open the event in Outlook on the web. The event will open in the browser if you are logged in to your mailbox via Outlook on the web. You will be prompted to login if you are not already logged in with the browser. This URL cannot be accessed from within an iFrame.
reminderFireTime	DateTimeTimeZone	The date, time, and time zone that the reminder is set to occur.

scheduleInformation

Property	Type	Description
availabilityView	String	Represents a merged view of availability of all the items in scheduleItems. The view consists of time slots. Availability during each time slot is indicated with: 0= free, 1= tentative, 2= busy, 3= out of office, 4= working elsewhere.
error	freeBusyError	Error information from attempting to get the availability of the user, distribution list, or resource.
scheduleId	String	An SMTP address of the user, distribution list, or resource, identifying an instance of scheduleInformation.
scheduleItems	scheduleItem collection	Contains the items that describe the availability of the user or resource.
workingHours	workingHours	The days of the week and hours in a specific time zone that the user works. These are set as part of the user's mailboxSettings.

search-api-overview

searchRequest

Property	Type	Description
aggregationFilters	String collection	Contains one or more filters to obtain search results aggregated and filtered to a specific value of a field. Optional. Build this filter based on a prior search that aggregates by the same field. From the response of the prior search, identify the searchBucket that filters results to the specific value of the field, use the string in its aggregationFilterToken property, and build an aggregation filter string in the format "{field}:\"{aggregationFilterToken}\"". If multiple values for the same field need to be provided, use the strings in its aggregationFilterToken property and build an aggregation filter string in the format "{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")". For example, searching and aggregating drive items by file type returns a searchBucket for the file type docx in the response. You can conveniently use the aggregationFilterToken returned for this searchBucket in a subsequent search query and filter matches down to drive items of the docx file type. Example 1 and example 2 show the actual requests and responses.
aggregations	aggregationOption collection	Specifies aggregations (also known as refiners) to be returned alongside search results. Optional.
contentSources	String collection	Contains the connection to be targeted.
enableTopResults	Boolean	This triggers hybrid sort for messages : the first 3 messages are the most relevant. This property is only applicable to entityType=message. Optional.
entityTypes	entityType collection	One or more types of resources expected in the response. Possible values are: list, site, listItem, message, event, drive, driveItem, externalItem. See known limitations for those combinations of two or more entity types that are supported in the same search request. Required.
fields	String collection	Contains the fields to be returned for each resource object specified in entityTypes, allowing customization of the fields returned by default; otherwise, including additional fields such as custom managed properties from SharePoint and OneDrive, or custom fields in externalItem from the content that Microsoft Graph connectors bring in. The fields property can use the semantic labels applied to properties. For example, if a property is labeled as title, you can retrieve it using the following syntax: label_title. Optional.
from	Int32	Specifies the offset for the search results. Offset 0 returns the very first result. Optional.
query	searchQuery	Contains the query terms. Required.
queryAlterationOptions	searchAlterationOptions	Query alteration options formatted in a JSON blob that contains two optional flags related to spelling correction. Optional.
resultTemplateOptions	resultTemplateOption collection	Provides the search result template options to render search results from connectors.
size	Int32	The size of the page to be retrieved.The maximum value is 1000. Optional.
sortProperties	sortProperty collection	Contains the ordered collection of fields and direction to sort results. There can be at most 5 sort properties in the collection. Optional.

searchResponse

Property	Type	Description
hitsContainers	searchHitsContainer collection	A collection of search results.
queryAlterationResponse	alterationResponse	Provides information related to spelling corrections in the alteration response.
resultTemplates	resultTemplate collection	A dictionary of resultTemplateIds and associated values, which include the name and JSON schema of the result templates.
searchTerms	String collection	Contains the search terms sent in the initial search query.