Tasks.Read
Allows the app to read the signed-in user’s tasks and task lists, including any shared with the user. Doesn't include permission to create, delete, or update anything.
Merill's Note
For an app to access data in Microsoft Graph, the user or administrator must grant it the permissions it needs. This article lists all the Microsoft Graph APIs and your tenant data that can be accessed by the application (vendor/developer) if you consent to the
Tasks.Read
permission.If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the
Export-MsIdAppConsentGrantReport
command. See How To: Run a quick OAuth app audit of your tenant
Category | Application | Delegated |
---|---|---|
Identifier | - | f45671fb-e0fe-4b4b-be20-3d3ce43f1bcb |
DisplayText | - | Read user's tasks and task lists |
Description | - | Allows the app to read the signed-in user’s tasks and task lists, including any shared with the user. Doesn't include permission to create, delete, or update anything. |
AdminConsentRequired | Yes | No |
Graph Methods
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
Methods | |
---|---|
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
Methods | |
---|---|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
Commands | |
---|---|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
Commands | |
---|---|
Resources
Granting this permission allows the calling application to access (and/or update) the following information in your tenant.
- attachment
- basetask
- basetasklist
- calendar
- checklistItem
- contact
- contactFolder
- conversation
- conversationThread
- event
- eventMessage
- extended-properties-overview
- fileAttachment
- group
- itemAttachment
- linkedResource
- linkedresource_v2
- mailFolder
- message
- multiValueLegacyExtendedProperty
- outlooktask
- outlooktaskfolder
- outlooktaskgroup
- planner-overview
- plannerAssignedToTaskBoardTaskFormat
- plannerBucket
- plannerBucketTaskBoardTaskFormat
- plannerPlan
- plannerPlanContainer
- plannerPlanDetails
- plannerProgressTaskBoardTaskFormat
- plannerRoster
- plannerRosterMember
- plannerTask
- plannerTaskDetails
- plannerUser
- post
- referenceAttachment
- singleValueLegacyExtendedProperty
- taskFileAttachment
- todoTask
- todoTaskList
- user
Graph reference: 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. |
Graph reference: basetask
Property | Type | Description |
---|---|---|
textBody | String | The task body in text format that typically contains information about the task. |
bodyLastModifiedDateTime | DateTimeOffset | The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
completedDateTime | DateTimeOffset | The date when the task was finished. |
createdDateTime | DateTimeOffset | The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
displayName | String | The name of the task. |
dueDateTime | dateTimeTimeZone | The date in the specified time zone that the task is to be finished. |
id | String | Unique identifier for the task. By default, this value will not change if a task is moved from one list to another. |
importance | importance | The importance of the task. Possible values are: low , normal , high . The possible values are: low , normal , high . |
lastModifiedDateTime | DateTimeOffset | The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
viewpoint | taskViewpoint | Properties that are personal to a user such as reminderDateTime and categories. |
recurrence | patternedRecurrence | The recurrence pattern for the task. |
startDateTime | dateTimeTimeZone | The date in the specified time zone when the task is to begin. |
status | taskStatus_v2 | Indicates the state or progress of the task. Possible values are: notStarted , inProgress , completed ,unknownFutureValue . |
Graph reference: basetasklist
Property | Type | Description |
---|---|---|
displayName | String | The name of the task list. |
id | String | The identifier of the task list, unique in the user's mailbox. Read-only. |
Graph reference: 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 |
Graph reference: checklistItem
Property | Type | Description |
---|---|---|
checkedDateTime | DateTimeOffset | The date and time when the checklistItem was finished. |
createdDateTime | DateTimeOffset | The date and time when the checklistItem was created. |
displayName | String | Indicates the title of the checklistItem. |
id | String | Server generated ID for the the checkListItem |
isChecked | Boolean | State that indicates whether the item is checked off or not. |
Graph reference: contact
Property | Type | Description |
---|---|---|
assistantName | String | The name of the contact's assistant. |
birthday | DateTimeOffset | The contact's birthday. 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 |
businessAddress | PhysicalAddress | The contact's business address. |
businessHomePage | String | The business home page of the contact. |
businessPhones | String collection | The contact's business phone numbers. |
categories | String collection | The categories associated with the contact. |
changeKey | String | Identifies the version of the contact. Every time the contact is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. |
children | String collection | The names of the contact's children. |
companyName | String | The name of the contact's company. |
createdDateTime | DateTimeOffset | The time the contact was created. 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 |
department | String | The contact's department. |
displayName | String | The contact's display name. You can specify the display name in a create or update operation. Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. To preserve a pre-existing value, always include it as displayName in an update operation. |
emailAddresses | EmailAddress collection | The contact's email addresses. |
fileAs | String | The name the contact is filed under. |
generation | String | The contact's suffix. |
givenName | String | The contact's given name. |
homeAddress | PhysicalAddress | The contact's home address. |
homePhones | String collection | The contact's home phone numbers. |
id | String | The contact's unique identifier. !INCLUDE [outlook-beta-id] Read-only. |
imAddresses | String collection | The contact's instant messaging (IM) addresses. |
initials | String | The contact's initials. |
jobTitle | String | The contact’s job title. |
lastModifiedDateTime | DateTimeOffset | The time the contact was modified. 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 |
manager | String | The name of the contact's manager. |
middleName | String | The contact's middle name. |
mobilePhone | String | The contact's mobile phone number. |
nickName | String | The contact's nickname. |
officeLocation | String | The location of the contact's office. |
otherAddress | PhysicalAddress | Other addresses for the contact. |
parentFolderId | String | The ID of the contact's parent folder. |
personalNotes | String | The user's notes about the contact. |
profession | String | The contact's profession. |
spouseName | String | The name of the contact's spouse/partner. |
surname | String | The contact's surname. |
title | String | The contact's title. |
yomiCompanyName | String | The phonetic Japanese company name of the contact. |
yomiGivenName | String | The phonetic Japanese given name (first name) of the contact. |
yomiSurname | String | The phonetic Japanese surname (last name) of the contact. |
Graph reference: contactFolder
Property | Type | Description |
---|---|---|
displayName | String | The folder's display name. |
id | String | Unique identifier of the contact folder. Read-only. |
parentFolderId | String | The ID of the folder's parent folder. |
Graph reference: conversation
Property | Type | Description |
---|---|---|
hasAttachments | Boolean | Indicates whether any of the posts within this Conversation has at least one attachment. Supports $filter (eq , ne ) and $search . |
id | String | The conversations's unique identifier. Read-only. |
lastDeliveredDateTime | 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 |
preview | String | A short summary from the body of the latest post in this conversation. Supports $filter (eq , ne , le , ge ). |
topic | String | The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. |
uniqueSenders | String collection | All the users that sent a message to this Conversation. |
Graph reference: conversationThread
Property | Type | Description |
---|---|---|
ccRecipients | recipient collection | The Cc: recipients for the thread. Returned only on $select . |
hasAttachments | Boolean | Indicates whether any of the posts within this thread has at least one attachment. Returned by default. |
id | String | Read-only. Returned by default. |
isLocked | Boolean | Indicates if the thread is locked. Returned by default. |
lastDeliveredDateTime | 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 .Returned by default. |
preview | String | A short summary from the body of the latest post in this conversation. Returned by default. |
topic | String | The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. Returned by default. |
toRecipients | recipient collection | The To: recipients for the thread. Returned only on $select . |
uniqueSenders | String collection | All the users that sent a message to this thread. Returned by default. |
Graph reference: 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. |
Graph reference: eventMessage
Property | Type | Description |
---|---|---|
bccRecipients | recipient collection | The Bcc: recipients for the message. |
body | itemBody | The body of the message. It can be in HTML or text format. |
bodyPreview | String | The first 255 characters of the message body. It is in text format. |
categories | String collection | The categories associated with the message. |
ccRecipients | recipient collection | The Cc: recipients for the message. |
changeKey | String | The version of the message. |
conversationId | String | The ID of the conversation the email belongs to. |
conversationIndex | Edm.Binary | Indicates the position of the message within the conversation. |
createdDateTime | DateTimeOffset | The date and time the message was created. |
flag | followupFlag | The flag value that indicates the status, start date, due date, or completion date for the message. |
from | recipient | The owner of the mailbox from which the message is sent. In most cases, this value is the same as the sender property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message. |
hasAttachments | Boolean | Indicates whether the message has attachments. |
id | String | Unique identifier for the event message. !INCLUDE [outlook-beta-id] Read-only. |
importance | String | The importance of the message: low , normal , high . |
inferenceClassification | String | The possible values are: focused , other . |
internetMessageHeaders | internetMessageHeader collection | The collection of message headers, defined by RFC5322, that provide details of the network path taken by a message from the sender to the recipient. Read-only. |
internetMessageId | String | The message ID in the format specified by RFC2822. |
isDelegated | Boolean | True if this meeting request is accessible to a delegate, false otherwise. Default is false. |
isDeliveryReceiptRequested | Boolean | Indicates whether a read receipt is requested for the message. |
isDraft | Boolean | Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet. |
isRead | Boolean | Indicates whether the message has been read. |
isReadReceiptRequested | Boolean | Indicates whether a read receipt is requested for the message. |
lastModifiedDateTime | DateTimeOffset | The date and time the message was last changed. |
meetingMessageType | meetingMessageType | The type of event message: none , meetingRequest , meetingCancelled , meetingAccepted , meetingTenativelyAccepted , meetingDeclined . |
parentFolderId | String | The unique identifier for the message's parent mailFolder. |
receivedDateTime | DateTimeOffset | The date and time the message was received. |
replyTo | recipient collection | The email addresses to use when replying. |
sender | recipient | The account that is actually used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message. |
sentDateTime | DateTimeOffset | The date and time the message was sent. |
subject | String | The subject of the message. |
toRecipients | recipient collection | The To: recipients for the message. |
uniqueBody | itemBody | The part of the body of the message that is unique to the current message. |
webLink | String | The URL to open the message in Outlook on the web. You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, then the browser will show the message in the Outlook on the web review pane. The message 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. |
Graph reference: extended-properties-overview
Graph reference: fileAttachment
Property | Type | Description |
---|---|---|
contentBytes | Edm.Binary | The base64-encoded contents of the file. |
contentId | String | The ID of the attachment in the Exchange store. |
contentLocation | String | Don't use this property as it isn't supported. |
contentType | String | The content type of the attachment. |
id | String | The attachment ID. |
isInline | Boolean | Set to true if the attachment is an inline attachment. |
lastModifiedDateTime | DateTimeOffset | The date and time when the attachment was last modified. |
name | String | The name representing the text that is displayed below the icon representing the embedded attachment and doesn't need to be the actual file name. |
size | Int32 | The size in bytes of the attachment. |
Graph reference: group
Property | Type | Description |
---|---|---|
allowExternalSenders | Boolean | Indicates if people external to the organization can send messages to the group. The default value is false . Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
assignedLabels | assignedLabel collection | The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select . This property can be updated only in delegated scenarios where the caller requires both the Microsoft Graph permission and a supported administrator role. |
assignedLicenses | assignedLicense collection | The licenses that are assigned to the group. Returned only on $select . Supports $filter (eq ).Read-only. |
autoSubscribeNewMembers | Boolean | Indicates if new members added to the group are autosubscribed to receive email notifications. You can set this property in a PATCH request for the group; don't set it in the initial POST request that creates the group. Default value is false . Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
classification | String | Describes a classification for the group (such as low, medium, or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition. Returned by default. Supports $filter (eq , ne , not , ge , le , startsWith ). |
createdDateTime | DateTimeOffset | Timestamp of when the group was created. The value can't be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z . Returned by default. Read-only. |
deletedDateTime | DateTimeOffset | For some Microsoft Entra objects (user, group, application), if the object is deleted, it's first logically deleted, and this property is updated with the date and time when the object was deleted. Otherwise this property is null . If the object is restored, this property is updated to null . Inherited from directoryObject. |
description | String | An optional description for the group. Returned by default. Supports $filter (eq , ne , not , ge , le , startsWith ) and $search . |
displayName | String | The display name for the group. This property is required when a group is created and can't be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values), $search , and $orderby . |
expirationDateTime | DateTimeOffset | Timestamp of when the group is set to expire. It's null for security groups, but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z . Returned by default. Supports $filter (eq , ne , not , ge , le , in ). Read-only. |
groupTypes | String collection | Specifies the group type and its membership. If the collection contains Unified , the group is a Microsoft 365 group; otherwise, it's either a security group or a distribution group. For details, see groups overview.If the collection includes DynamicMembership , the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq , not ). |
hasMembersWithLicenseErrors | Boolean | Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example. Supports $filter (eq ). |
hideFromAddressLists | Boolean | True if the group isn't displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. The default value is false . Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
hideFromOutlookClients | Boolean | True if the group isn't displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. The default value is false . Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
id | String | The unique identifier for the group. Returned by default. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq , ne , not , in ). |
isArchived | Boolean | When a group is associated with a team, this property determines whether the team is in read-only mode. To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs. |
isAssignableToRole | Boolean | Indicates whether this group can be assigned to a Microsoft Entra role. Optional. This property can only be set while creating the group and is immutable. If set to true , the securityEnabled property must also be set to true , visibility must be Hidden , and the group can't be a dynamic group (that is, groupTypes can't contain DynamicMembership ). Only callers with at least the Privileged Role Administrator role can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Microsoft Entra role assignments Using this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports $filter (eq , ne , not ). |
isSubscribedByMail | Boolean | Indicates whether the signed-in user is subscribed to receive email conversations. The default value is true . Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
licenseProcessingState | String | Indicates the status of the group license assignment to all group members. The default value is false . Read-only. Possible values: QueuedForProcessing , ProcessingInProgress , and ProcessingComplete .Returned only on $select . Read-only. |
String | The SMTP address for the group, for example, "[email protected]". Returned by default. Read-only. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
|
mailEnabled | Boolean | Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq , ne , not ). |
mailNickname | String | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following characters: @ () \ [] " ; : <> , SPACE . Required. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
membershipRule | String | The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership ). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq , ne , not , ge , le , startsWith ). |
membershipRuleProcessingState | String | Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused . Returned by default. Supports $filter (eq , ne , not , in ). |
onPremisesDomainName | String | Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Returned by default. Read-only. |
onPremisesLastSyncDateTime | DateTimeOffset | Indicates the last time at which the group was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z . Returned by default. Read-only. Supports $filter (eq , ne , not , ge , le , in ). |
onPremisesNetBiosName | String | Contains the on-premises netBios name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Returned by default. Read-only. |
onPremisesProvisioningErrors | onPremisesProvisioningError collection | Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq , not ). |
onPremisesSamAccountName | String | Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith ). Read-only. |
onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud. Read-only. Returned by default. Supports $filter (eq including on null values). |
onPremisesSyncEnabled | Boolean | true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq , ne , not , in , and eq on null values). |
preferredDataLocation | String | The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator's preferred data location. To set this property, the calling app must be granted the Directory.ReadWrite.All permission and the user be assigned at least one of the following Microsoft Entra roles:
For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default. |
preferredLanguage | String | The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example, en-US . Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
proxyAddresses | String collection | Email addresses for the group that direct to the same group mailbox. For example: ["SMTP: [email protected]", "smtp: [email protected]"] . The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq , not , ge , le , startsWith , endsWith , /$count eq 0 , /$count ne 0 ). |
renewedDateTime | DateTimeOffset | Timestamp of when the group was last renewed. This value can't be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z . Returned by default. Supports $filter (eq , ne , not , ge , le , in ). Read-only. |
securityEnabled | Boolean | Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq , ne , not , in ). |
securityIdentifier | String | Security identifier of the group, used in Windows scenarios. Read-only. Returned by default. |
serviceProvisioningErrors | serviceProvisioningError collection | Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq , not , for isResolved and serviceInstance). |
theme | string | Specifies a Microsoft 365 group's color theme. Possible values are Teal , Purple , Green , Blue , Pink , Orange , or Red . Returned by default. |
uniqueName | String | The unique identifier that can be assigned to a group and used as an alternate key. Immutable. Read-only. |
unseenCount | Int32 | Count of conversations that received new posts since the signed-in user last visited the group. Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
visibility | String | Specifies the group join policy and group content visibility for groups. Possible values are: Private , Public , or HiddenMembership . HiddenMembership can be set only for Microsoft 365 groups when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation.If visibility value isn't specified during group creation on Microsoft Graph, a security group is created as Private by default, and the Microsoft 365 group is Public . Groups assignable to roles are always Private . To learn more, see group visibility options. Returned by default. Nullable. |
Graph reference: itemAttachment
Property | Type | Description |
---|---|---|
contentType | String | The content type of the attachment. Returned as null by default, when not set explicitly. Optional. |
id | String | The attachment ID. |
isInline | Boolean | Set to true if the attachment is inline, such as an embedded image within the body of the item. |
lastModifiedDateTime | DateTimeOffset | The last time and date that the attachment was modified. |
name | String | The display name of the attachment. |
size | Int32 | The size in bytes of the attachment. |
Graph reference: linkedResource
Property | Type | Description |
---|---|---|
applicationName | String | The app name of the source that sends the linkedResource. |
displayName | String | The title of the linkedResource. |
externalId | String | ID of the object that is associated with this task on the third-party/partner system. |
id | String | Server generated ID for the linkedResource. Inherited from entity. |
webUrl | String | Deep link to the **l |
Graph reference: linkedresource_v2
Property | Type | Description |
---|---|---|
applicationName | String | Field indicating the app name of the source that is sending the linkedResource. |
displayName | String | Field indicating the title of the linkedResource. |
externalId | String | Id of the object that is associated with this task on the third-party/partner system. |
id | String | Server generated ID for the linkedResource. Inherited from entity. |
webUrl | String | Deep link to the **l |
Graph reference: mailFolder
Property | Type | Description |
---|---|---|
childFolderCount | Int32 | The number of immediate child mailFolders in the current mailFolder. |
displayName | String | The mailFolder's display name. |
id | String | The mailFolder's unique identifier. |
isHidden | Boolean | Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders. |
parentFolderId | String | The unique identifier for the mailFolder's parent mailFolder. |
totalItemCount | Int32 | The number of items in the mailFolder. |
unreadItemCount | Int32 | The number of items in the mailFolder marked as unread. |
Graph reference: message
Property | Type | Description |
---|---|---|
bccRecipients | recipient collection | The Bcc: recipients for the message. |
body | itemBody | The body of the message. It can be in HTML or text format. Find out about safe HTML in a message body. |
bodyPreview | String | The first 255 characters of the message body. It is in text format. |
ccRecipients | recipient collection | The Cc: recipients for the message. |
changeKey | String | The version of the message. |
conversationId | String | The ID of the conversation the email belongs to. |
conversationIndex | Edm.Binary | Indicates the position of the message within the conversation. |
createdDateTime | DateTimeOffset | The date and time the message was created. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
flag | followupFlag | The flag value that indicates the status, start date, due date, or completion date for the message. |
from | recipient | The owner of the mailbox from which the message is sent. In most cases, this value is the same as the sender property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message. |
hasAttachments | Boolean | Indicates whether the message has attachments. This property doesn't include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as <IMG src="cid:[email protected]"> . |
id | String | Unique identifier for the message. !INCLUDE [outlook-beta-id] Read-only. |
importance | importance | The importance of the message. The possible values are: low , normal , and high . |
inferenceClassification | inferenceClassificationType | The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other . |
internetMessageHeaders | internetMessageHeader collection | A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only. |
internetMessageId | String | The message ID in the format specified by RFC2822. |
isDeliveryReceiptRequested | Boolean | Indicates whether a read receipt is requested for the message. |
isDraft | Boolean | Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet. |
isRead | Boolean | Indicates whether the message has been read. |
isReadReceiptRequested | Boolean | Indicates whether a read receipt is requested for the message. |
lastModifiedDateTime | DateTimeOffset | The date and time the message was last changed. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
parentFolderId | String | The unique identifier for the message's parent mailFolder. |
receivedDateTime | DateTimeOffset | The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
replyTo | recipient collection | The email addresses to use when replying. |
sender | recipient | The account that is actually used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message. |
sentDateTime | DateTimeOffset | The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
subject | String | The subject of the message. |
toRecipients | recipient collection | The To: recipients for the message. |
uniqueBody | itemBody | The part of the body of the message that is unique to the current message. uniqueBody is not returned by default but can be retrieved for a given message by use of the ?$select=uniqueBody query. It can be in HTML or text format. |
webLink | String | The URL to open the message in Outlook on the web. You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane. The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser. This URL cannot be accessed from within an iFrame. |
Graph reference: multiValueLegacyExtendedProperty
Property | Type | Description |
---|---|---|
id | string | The property identifier. Read-only. |
value | string collection | A collection of property values. |
Graph reference: outlooktask
Property | Type | Description |
---|---|---|
assignedTo | String | The name of the person who has been assigned the task in Outlook. Read-only. |
body | itemBody | The task body that typically contains information about the task. Only the HTML type is supported. |
categories | String collection | The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined. |
changeKey | String | The version of the task. |
completedDateTime | dateTimeTimeZone | The date in the specified time zone that the task was finished. |
createdDateTime | DateTimeOffset | The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
dueDateTime | dateTimeTimeZone | The date in the specified time zone that the task is to be finished. |
hasAttachments | Boolean | Set to true if the task has attachments. |
id | String | Unique identifier for the task. !INCLUDE [outlook-beta-id] Read-only. |
importance | importance | The importance of the event. Possible values are: low , normal , high . |
isReminderOn | Boolean | Set to true if an alert is set to remind the user of the task. |
lastModifiedDateTime | DateTimeOffset | The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
owner | String | The name of the person who created the task. |
parentFolderId | String | The unique identifier for the task's parent folder. |
recurrence | patternedRecurrence | The recurrence pattern for the task. |
reminderDateTime | dateTimeTimeZone | The date and time for a reminder alert of the task to occur. |
sensitivity | sensitivity | Indicates the level of privacy for the task. Possible values are: normal , personal , private , confidential . |
startDateTime | dateTimeTimeZone | The date in the specified time zone when the task is to begin. |
status | taskStatus | Indicates the state or progress of the task. Possible values are: notStarted , inProgress , completed , waitingOnOthers , deferred . |
subject | String | A brief description or title of the task. |
Graph reference: outlooktaskfolder
Property | Type | Description |
---|---|---|
changeKey | String | The version of the task folder. |
id | String | The identifier of the task folder, unique in the user's mailbox. Read-only. |
isDefaultFolder | Boolean | True if the folder is the default task folder. |
name | String | The name of the task folder. |
parentGroupKey | Guid | The unique GUID identifier for the task folder's parent group. |
Graph reference: outlooktaskgroup
Property | Type | Description |
---|---|---|
changeKey | String | The version of the task group. |
groupKey | Edm.Guid | The unique GUID identifier for the task group. |
id | String | The unique string identifier of the task group. Read-only. |
isDefaultGroup | Boolean | True if the task group is the default task group. |
name | String | The name of the task group. |
Graph reference: planner-overview
Graph reference: plannerAssignedToTaskBoardTaskFormat
Property | Type | Description |
---|---|---|
id | String | ID of the resource. It's 28 characters long and case-sensitive. Format validation is done on the service. Read-only. |
orderHintsByAssignee | plannerOrderHintsByAssignee | Dictionary of hints used to order tasks on the AssignedTo view of the Task Board. The key of each entry is one of the users the task is assigned to and the value is the order hint. The format of each value is defined as outlined here. |
unassignedOrderHint | String | Hint value used to order the task on the AssignedTo view of the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee dictionary doesn't provide an order hint for the user the task is assigned to. The format is defined as outlined here. |
Graph reference: plannerBucket
Property | Type | Description |
---|---|---|
id | String | Read-only. ID of the bucket. It is 28 characters long and case-sensitive. Format validation is done on the service. |
name | String | Name of the bucket. |
orderHint | String | Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner. |
planId | String | Plan ID to which the bucket belongs. |
Graph reference: plannerBucketTaskBoardTaskFormat
Property | Type | Description |
---|---|---|
id | String | Read-only. ID of the resource. It's 28 characters long and case-sensitive. The format validation is done on the service. |
orderHint | String | Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner. |
Graph reference: plannerPlan
Property | Type | Description |
---|---|---|
container | plannerPlanContainer | Identifies the container of the plan. Specify only the url, the containerId and type, or all properties. After it's set, this property can’t be updated. Required. |
createdBy | identitySet | Read-only. The user who created the plan. |
createdDateTime | DateTimeOffset | Read-only. Date and time at which the plan is created. 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 |
id | String | Read-only. ID of the plan. It's 28 characters long and case-sensitive. Format validation is done on the service. |
owner (deprecated) | String | Use the container property instead. ID of the group that owns the plan. After it's set, this property can’t be updated. This property won't return a valid group ID if the container of the plan isn't a group. |
title | String | Required. Title of the plan. |
Graph reference: plannerPlanContainer
Property | Type | Description |
---|---|---|
containerId | String | The identifier of the resource that contains the plan. Optional. |
type | plannerContainerType | The type of the resource that contains the plan. For supported types, see the previous table. Possible values are: group , unknownFutureValue , roster . Note that you must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: roster . Optional. |
url | String | The full canonical URL of the container. Optional. |
Graph reference: plannerPlanDetails
Property | Type | Description |
---|---|---|
categoryDescriptions | plannerCategoryDescriptions | An object that specifies the descriptions of the 25 categories that can be associated with tasks in the plan. |
id | String | The unique identifier for the plan details. It's 28 characters long and case-sensitive. Format validation is done on the service. Read-only. |
sharedWith | plannerUserIds | Set of user IDs that this plan is shared with. If you're using Microsoft 365 groups, use the Groups API to manage group membership to share the group's plan. You can also add existing members of the group to this collection, although it isn't required for them to access the plan owned by the group. |
Graph reference: plannerProgressTaskBoardTaskFormat
Property | Type | Description |
---|---|---|
id | String | Read-only. ID of the resource. It's 28 characters long and case-sensitive. The format validation is done on the service. |
orderHint | String | Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner. |
Graph reference: plannerRoster
Property | Type | Description |
---|---|---|
assignedSensitivityLabel | sensitivityLabelAssignmentMethod | The sensitivity label applied to the roster. If mandatory labeling is enabled for the user and no label is specified, the user can't create the roster. Also, if labels are mandatory for the user, the user can't change the label of the roster to null . Possible values are: standard , privileged , auto , unknownFutureValue . |
id | String | Identifier of the **p |
Graph reference: plannerRosterMember
Property | Type | Description |
---|---|---|
id | String | The identifier of the plannerRosterMember. Inherited from entity |
roles | String collection | Additional roles associated with the PlannerRosterMember, which determines permissions of the member in the plannerRoster. Currently there are no available roles to assign, and every member has full control over the contents of the plannerRoster. |
tenantId | String | Identifier of the tenant the user belongs to. Currently only the users from the same tenant can be added to a plannerRoster. |
userId | String | Identifier of the user. |
Graph reference: plannerTask
Property | Type | Description |
---|---|---|
activeChecklistItemCount | Int32 | Number of checklist items with value set to false , representing incomplete items. |
appliedCategories | plannerAppliedCategories | The categories to which the task has been applied. See applied Categories for possible values. |
assigneePriority | String | Hint used to order items of this type in a list view. The format is defined as outlined here. |
assignments | plannerAssignments | The set of assignees the task is assigned to. |
bucketId | String | Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service. |
checklistItemCount | Int32 | Number of checklist items that are present on the task. |
completedBy | identitySet | Identity of the user that completed the task. |
completedDateTime | DateTimeOffset | Read-only. Date and time at which the 'percentComplete' of the task is set to '100' . 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 |
conversationThreadId | String | Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group. |
createdBy | identitySet | Identity of the user that created the task. |
createdDateTime | DateTimeOffset | Read-only. Date and time at which the task is created. 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 |
dueDateTime | DateTimeOffset | Date and time at which the task is due. 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 |
hasDescription | Boolean | Read-only. Value is true if the details object of the task has a nonempty description and false otherwise. |
id | String | Read-only. ID of the task. It's 28 characters long and case-sensitive. Format validation is done on the service. |
orderHint | String | Hint used to order items of this type in a list view. The format is defined as outlined here. |
percentComplete | Int32 | Percentage of task completion. When set to 100 , the task is considered completed. |
planId | String | Plan ID to which the task belongs. |
previewType | String | This sets the type of preview that shows up on the task. The possible values are: automatic , noPreview , checklist , description , reference . |
priority | Int32 | Priority of the task. The valid range of values is between 0 and 10 , with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as "urgent", 2 , 3 and 4 as "important", 5 , 6 , and 7 as "medium", and 8 , 9 , and 10 as "low". Additionally, Planner sets the value 1 for "urgent", 3 for "important", 5 for "medium", and 9 for "low". |
referenceCount | Int32 | Number of external references that exist on the task. |
startDateTime | DateTimeOffset | Date and time at which the task starts. 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 |
title | String | Title of the task. |
Graph reference: plannerTaskDetails
Property | Type | Description |
---|---|---|
checklist | plannerChecklistItems | The collection of checklist items on the task. |
description | String | Description of the task. |
id | String | Read-only. ID of the task details. It's 28 characters long and case-sensitive. Format validation is done on the service. |
previewType | string | This sets the type of preview that shows up on the task. The possible values are: automatic , noPreview , checklist , description , reference . When set to automatic the displayed preview is chosen by the app viewing the task. |
references | plannerExternalReferences | The collection of references on the task. |
Graph reference: plannerUser
Property | Type | Description |
---|---|---|
id | String | Read-only. The unique identifier for the **p |
Graph reference: post
Property | Type | Description |
---|---|---|
body | itemBody | The contents of the post. This is a default property. This property can be null. |
categories | String collection | The categories associated with the post. |
changeKey | String | Identifies the version of the post. Every time the post is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. |
conversationId | String | Unique ID of the conversation. Read-only. |
conversationThreadId | String | Unique ID of the conversation thread. Read-only. |
createdDateTime | DateTimeOffset | Specifies when the post was created. The DateTimeOffset 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 |
from | recipient | Used in delegate access scenarios. Indicates who posted the message on behalf of another user. This is a default property. |
hasAttachments | Boolean | Indicates whether the post has at least one attachment. This is a default property. |
id | String | Read-only. |
lastModifiedDateTime | DateTimeOffset | Specifies when the post was last modified. The DateTimeOffset 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 |
newParticipants | recipient collection | Conversation participants that were added to the thread as part of this post. |
receivedDateTime | DateTimeOffset | Specifies when the post was received. The DateTimeOffset 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 |
sender | recipient | Contains the address of the sender. The value of Sender is assumed to be the address of the authenticated user in the case when Sender is not specified. This is a default property. |
Graph reference: referenceAttachment
Property | Type | Description |
---|---|---|
contentType | String | The content type of the attachment. Returned as null by default, when not set explicitly. Optional. |
id | String | The attachment ID. Read-only. |
isInline | Boolean | Set to true if the attachment appears inline in the body of the embedding object. |
lastModifiedDateTime | DateTimeOffset | The date and time when the attachment was last modified. 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 text that is displayed below the icon representing the embedded attachment. This does not need to be the actual file name. |
size | Int32 | The size of the metadata that is stored on the message for the attachment in bytes. This value does not indicate the size of the actual file. |
Graph reference: singleValueLegacyExtendedProperty
Property | Type | Description |
---|---|---|
id | string | The property ID used to identify the property. Read-only. |
value | string | A property value. |
Graph reference: taskFileAttachment
Property | Type | Description |
---|---|---|
contentBytes | Binary | The base64-encoded contents of the file. |
contentType | String | The content type of the attachment. Inherited from attachmentBase. |
id | String | The ID of the attachment. Inherited from entity. |
lastModifiedDateTime | DateTimeOffset | The date and time when the attachment was last modified. Inherited from attachmentBase. |
name | String | The name of the text displayed under the icon that represents the embedded attachment. This does not need to be the actual file name. Inherited from attachmentBase. |
size | Int32 | The size in bytes of the attachment. Inherited from attachmentBase. |
Graph reference: todoTask
Property | Type | Description |
---|---|---|
body | itemBody | The task body that typically contains information about the task. |
bodyLastModifiedDateTime | DateTimeOffset | The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
categories | String collection | The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined. |
completedDateTime | dateTimeTimeZone | The date and time in the specified time zone that the task was finished. |
createdDateTime | DateTimeOffset | The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
dueDateTime | dateTimeTimeZone | The date and time in the specified time zone that the task is to be finished. |
hasAttachments | Boolean | Indicates whether the task has attachments. |
id | String | Unique identifier for the task. By default, this value changes when the item is moved from one list to another. |
importance | importance | The importance of the task. Possible values are: low , normal , high . |
isReminderOn | Boolean | Set to true if an alert is set to remind the user of the task. |
lastModifiedDateTime | DateTimeOffset | The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
recurrence | patternedRecurrence | The recurrence pattern for the task. |
reminderDateTime | dateTimeTimeZone | The date and time in the specified time zone for a reminder alert of the task to occur. |
startDateTime | dateTimeTimeZone | The date and time in the specified time zone at which the task is scheduled to start. |
status | taskStatus | Indicates the state or progress of the task. Possible values are: notStarted , inProgress , completed , waitingOnOthers , deferred . |
title | String | A brief description of the task. |
Graph reference: todoTaskList
Property | Type | Description |
---|---|---|
displayName | String | The name of the task list. |
id | String | The identifier of the task list, unique in the user's mailbox. Read-only. Inherited from entity |
isOwner | Boolean | True if the user is owner of the given task list. |
isShared | Boolean | True if the task list is shared with other users |
wellknownListName | wellknownListName | Property indicating the list name if the given list is a well-known list. Possible values are: none , defaultList , flaggedEmails , unknownFutureValue . |
Graph reference: user
Property | Type | Description |
---|---|---|
aboutMe | String | A freeform text entry field for the user to describe themselves. Returned only on $select . |
accountEnabled | Boolean | true if the account is enabled; otherwise, false . This property is required when a user is created. Returned only on $select . Supports $filter (eq , ne , not , and in ). |
ageGroup | ageGroup | Sets the age group of the user. Allowed values: null , Minor , NotAdult , and Adult . For more information, see legal age group property definitions. Returned only on $select . Supports $filter (eq , ne , not , and in ). |
assignedLicenses | assignedLicense collection | The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn't differentiate between directly assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly assigned and inherited licenses. Not nullable. Returned only on $select . Supports $filter (eq , not , /$count eq 0 , /$count ne 0 ). |
assignedPlans | assignedPlan collection | The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select . Supports $filter (eq and not ). |
birthday | DateTimeOffset | The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z . Returned only on $select . |
businessPhones | String collection | The telephone numbers for the user. NOTE: Although it's a string collection, only one number can be set for this property. Read-only for users synced from the on-premises directory. Returned by default. Supports $filter (eq , not , ge , le , startsWith ). |
city | String | The city where the user is located. Maximum length is 128 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
companyName | String | The name of the company that the user is associated with. This property can be useful for describing the company that a guest comes from. The maximum length is 64 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
consentProvidedForMinor | consentProvidedForMinor | Sets whether consent was obtained for minors. Allowed values: null , Granted , Denied , and NotRequired . For more information, see legal age group property definitions. Returned only on $select . Supports $filter (eq , ne , not , and in ). |
country | String | The country/region where the user is located; for example, US or UK . Maximum length is 128 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
createdDateTime | DateTimeOffset | The date and time the user was created, in ISO 8601 format and UTC. The value can't be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
creationType | String | Indicates whether the user account was created through one of the following methods:
Read-only. Returned only on $select . Supports $filter (eq , ne , not , in ). |
customSecurityAttributes | customSecurityAttributeValue | An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. Returned only on $select . Supports $filter (eq , ne , not , startsWith ). The filter value is case-sensitive. |
deletedDateTime | DateTimeOffset | The date and time the user was deleted. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
department | String | The name of the department in which the user works. Maximum length is 64 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , and eq on null values). |
displayName | String | The name displayed in the address book for the user. This value is usually the combination of the user's first name, middle initial, and family name. This property is required when a user is created and it can't be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values), $orderby , and $search . |
employeeHireDate | DateTimeOffset | The date and time when the user was hired or will start work in a future hire. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
employeeLeaveDateTime | DateTimeOffset | The date and time when the user left or will leave the organization. Supports $filter (eq , ne , not , ge , le , in ). For more information, see Configure the employeeLeaveDateTime property for a user. |
employeeId | String | The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
employeeOrgData | employeeOrgData | Represents organization data (for example, division and costCenter) associated with a user. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
employeeType | String | Captures enterprise worker type. For example, Employee , Contractor , Consultant , or Vendor . Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
externalUserState | String | For a guest invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted , or null for all other users. Returned only on $select . Supports $filter (eq , ne , not , in ). |
externalUserStateChangeDateTime | DateTimeOffset | Shows the timestamp for the latest change to the externalUserState property. Returned only on $select . Supports $filter (eq , ne , not , in ). |
faxNumber | String | The fax number of the user. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
givenName | String | The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
hireDate | DateTimeOffset | The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z . Returned only on $select . Note: This property is specific to SharePoint in Microsoft 365. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs. |
id | String | The unique identifier for the user. Should be treated as an opaque identifier. Inherited from directoryObject. Key. Not nullable. Read-only. Returned by default. Supports $filter (eq , ne , not , in ). |
identities | objectIdentity collection | Represents the identities that can be used to sign in to this user account. Microsoft (also known as a local account), organizations, or social identity providers such as Facebook, Google, and Microsoft can provide identity and tie it to a user account. It might contain multiple items with the same signInType value. Returned only on $select . Supports $filter (eq ) with limitations. |
imAddresses | String collection | The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Returned only on $select . Supports $filter (eq , not , ge , le , startsWith ). |
interests | String collection | A list for the user to describe their interests. Returned only on $select . |
isResourceAccount | Boolean | Don't use – reserved for future use. |
jobTitle | String | The user's job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
lastPasswordChangeDateTime | DateTimeOffset | The time when this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Returned only on $select . |
legalAgeGroupClassification | legalAgeGroupClassification | Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null , MinorWithOutParentalConsent , MinorWithParentalConsent , MinorNoParentalConsentRequired , NotAdult , and Adult . For more information, see legal age group property definitions. Returned only on $select . |
licenseAssignmentStates | licenseAssignmentState collection | State of license assignments for this user. Also indicates licenses that are directly assigned or the user inherited through group memberships. Read-only. Returned only on $select . |
String | The SMTP address for the user, for example, [email protected] . Changes to this property update the user's proxyAddresses collection to include the value as an SMTP address. This property can't contain accent characters. NOTE: We don't recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , endsWith , and eq on null values). |
|
mailboxSettings | mailboxSettings | Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Returned only on $select . |
mailNickname | String | The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
mobilePhone | String | The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory. Maximum length is 64 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values) and $search . |
mySite | String | The URL for the user's site. Returned only on $select . |
officeLocation | String | The office location in the user's place of business. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
onPremisesDistinguishedName | String | Contains the on-premises Active Directory distinguished name or DN . The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select . |
onPremisesDomainName | String | Contains the on-premises domainFQDN , also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select . |
onPremisesExtensionAttributes | onPremisesExtensionAttributes | Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. Each attribute can store up to 1024 characters. false ), these properties can be set during the creation or update of a user object. Returned only on $select . Supports $filter (eq , ne , not , in ). |
onPremisesImmutableId | String | This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters can't be used when specifying this property. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
onPremisesLastSyncDateTime | DateTimeOffset | Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z . The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
onPremisesProvisioningErrors | onPremisesProvisioningError collection | Errors when using Microsoft synchronization product during provisioning. Returned only on $select . Supports $filter (eq , not , ge , le ). |
onPremisesSamAccountName | String | Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Returned only on $select . Supports $filter (eq including on null values). |
onPremisesSyncEnabled | Boolean | true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn't being synced and can be managed in Microsoft Entra ID. Read-only. Returned only on $select . Supports $filter (eq , ne , not , in , and eq on null values). |
onPremisesUserPrincipalName | String | Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
otherMails | String collection | A list of other email addresses for the user; for example: ["[email protected]", "[email protected]"] . NOTE: This property can't contain accent characters. Returned only on $select . Supports $filter (eq , not , ge , le , in , startsWith , endsWith , /$count eq 0 , /$count ne 0 ). |
passwordPolicies | String | Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword , which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two might be specified together; for example: DisablePasswordExpiration, DisableStrongPassword . Returned only on $select . For more information on the default password policies, see Microsoft Entra password policies. Supports $filter (ne , not , and eq on null values). |
passwordProfile | passwordProfile | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required. Returned only on $select . Supports $filter (eq , ne , not , in , and eq on null values). To update this property: |
pastProjects | String collection | A list for the user to enumerate their past projects. Returned only on $select . |
postalCode | String | The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
preferredDataLocation | String | The preferred data location for the user. For more information, see OneDrive Online Multi-Geo. |
preferredLanguage | String | The preferred language for the user. The preferred language format is based on RFC 4646. The name is a combination of an ISO 639 two-letter lowercase culture code associated with the language, and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: "en-US", or "es-ES". Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values) |
preferredName | String | The preferred name for the user. Not Supported. This attribute returns an empty string. Returned only on $select . |
provisionedPlans | provisionedPlan collection | The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select . Supports $filter (eq , not , ge , le ). |
proxyAddresses | String collection | For example: "SMTP: [email protected]", "smtp: [email protected]"] . Changes to the mail property update this collection to include the value as an SMTP address. For more information, see [mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address, while those addresses prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Returned only on $select . Supports $filter (eq , not , ge , le , startsWith , endsWith , /$count eq 0 , /$count ne 0 ). |
refreshTokensValidFromDateTime | DateTimeOffset | Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Returned only on $select . Read-only. |
responsibilities | String collection | A list for the user to enumerate their responsibilities. Returned only on $select . |
serviceProvisioningErrors | serviceProvisioningError collection | Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq , not , for isResolved and serviceInstance). |
schools | String collection | A list for the user to enumerate the schools they attended. Returned only on $select . |
securityIdentifier | String | Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq , not , ge , le , startsWith ). |
showInAddressList | Boolean | Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue. |
signInActivity | signInActivity | Get the last signed-in date and request ID of the sign-in for a given user. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le ) but not with any other filterable properties. Note: |
signInSessionsValidFromDateTime | DateTimeOffset | Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset. Returned only on $select . |
skills | String collection | A list for the user to enumerate their skills. Returned only on $select . |
state | String | The state or province in the user's address. Maximum length is 128 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
streetAddress | String | The street address of the user's place of business. Maximum length is 1,024 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
surname | String | The user's surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
usageLocation | String | A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries. Examples include: US , JP , and GB . Not nullable. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
userPrincipalName | String | The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this value should map to the user's email name. The general format is alias@domain, where the domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization. NOTE: This property can't contain accent characters. Only the following characters are allowed A - Z , a - z , 0 - 9 , ' . - _ ! # ^ ~ . For the complete list of allowed characters, see username policies. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , endsWith ) and $orderby . |
userType | String | A string value that can be used to classify user types in your directory. The possible values are Member and Guest . Returned only on $select . Supports $filter (eq , ne , not , in , and eq on null values). **N |