Show / Hide Table of Contents

Tasks.ReadWrite.All

Allows the app to create, read, update and delete all users’ tasks and task lists in your organization, without a signed-in user

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A DELETE /planner/buckets/{id}
V1 A DELETE /planner/plans/{id}
V1 A DELETE /planner/rosters/{plannerRosterId}
V1 A DELETE /planner/rosters/{plannerRosterId}/members/{plannerRosterMemberId}
V1 A DELETE /planner/tasks/{id}
V1 A GET /drive/root/createdByUser/planner/tasks
V1 A GET /groups/{group-id}/planner/plans
V1 A GET /me/planner
V1 A GET /me/planner/tasks
V1 A GET /planner/buckets
V1 A GET /planner/buckets/{id}
V1 A GET /planner/buckets/{id}/tasks
V1 A GET /planner/plans
V1 A GET /planner/plans/{id}/details
V1 A GET /planner/plans/{plan-id}
V1 A GET /planner/plans/{plan-id}/buckets
V1 A GET /planner/plans/{plan-id}/tasks
V1 A GET /planner/rosters/{plannerRosterId}
V1 A GET /planner/rosters/{plannerRosterId}/members
V1 A GET /planner/rosters/{plannerRosterId}/members/{plannerRosterMemberId}
V1 A GET /planner/rosters/{plannerRosterId}/plans
V1 A GET /planner/tasks
V1 A GET /planner/tasks/{id}
V1 A GET /planner/tasks/{id}/assignedToTaskBoardFormat
V1 A GET /planner/tasks/{id}/bucketTaskBoardFormat
V1 A GET /planner/tasks/{id}/details
V1 A GET /planner/tasks/{id}/progressTaskBoardFormat
V1 A GET /users/{id}/planner
V1 A GET /users/{id}/planner/tasks
V1 A GET /users/{usersId}/planner/rosterPlans
V1 A PATCH /planner/buckets/{id}
V1 A PATCH /planner/plans/{id}/details
V1 A PATCH /planner/plans/{plan-id}
V1 A PATCH /planner/tasks/{id}
V1 A PATCH /planner/tasks/{id}/assignedToTaskBoardFormat
V1 A PATCH /planner/tasks/{id}/bucketTaskBoardFormat
V1 A PATCH /planner/tasks/{id}/details
V1 A PATCH /planner/tasks/{id}/progressTaskBoardFormat
V1 A POST /planner/buckets
V1 A POST /planner/plans
V1 A POST /planner/rosters
V1 A POST /planner/rosters/{plannerRosterId}/members
V1 A POST /planner/tasks

Application Permission

Id 44e666d1-d276-445b-a5fc-8815eeb81d55
Display String Read and write all users’ tasks and tasklists
Description Allows the app to create, read, update and delete all users’ tasks and task lists in your organization, without a signed-in user

Resources

group

Property Type Description
allowExternalSenders Boolean Indicates if people external to the organization can send messages to the group. 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.
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 will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not 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 cannot 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 Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.
deletedDateTime DateTimeOffset For some Azure Active Directory objects (user, group, application), if the object is deleted, it is 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.
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 cannot 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. The value cannot 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 Jan 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 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 is not 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. Default value is false.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
hideFromOutlookClients Boolean True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. 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 an Azure Active Directory role or not. 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 cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership).

Only callers in Global Administrator and Privileged Role Administrator roles 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 Azure AD role assignments

Using this feature requires a Azure AD Premium P1 license. Returned by default. Supports $filter (eq, ne, not).
isSubscribedByMail Boolean Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
licenseProcessingState String Indicates status of the group license assignment to all members of the group. Default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.

Returned only on $select. Read-only.
mail 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: @ () \ [] " ; : <> , 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).
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 Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).
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 who are synchronizing their on-premises directory to Azure Active Directory via Azure AD 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 that was synchronized from on-premises to the cloud.

Returned by default. Supports $filter (eq including on null values). Read-only.
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 been 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 user must be assigned one of the following Azure AD roles:
  • Global Administrator
  • User Account Administrator
  • Directory Writer
  • Exchange Administrator
  • SharePoint Administrator

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 cannot 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 time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.
resourceBehaviorOptions String collection Specifies the group behaviors that can be set for a Microsoft 365 group during creation. This can be set only as part of creation (POST). Possible values are AllowOnlyMembersToPost, HideGroupInOutlook, SubscribeNewGroupMembers, WelcomeEmailDisabled. For more information, see Set Microsoft 365 group behaviors and provisioning options.
resourceProvisioningOptions String collection Specifies the group resources that are provisioned as part of Microsoft 365 group creation, that are not normally part of default group creation. Possible value is Team. For more information, see Set Microsoft 365 group behaviors and provisioning options.
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.

Returned by default.
theme string Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red.

Returned by default.
unseenCount Int32 Count of conversations that have 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 is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. Groups assignable to roles are always Private. See group visibility options to learn more.

Returned by default. Nullable.

itemBody

Property Type Description
content String The content of the item.
contentType bodyType The type of the content. Possible values are text and html.

planner-identifiers-disclaimer

planner-order-hint-format

planner-overview

plannerAppliedCategories

plannerAssignedToTaskBoardTaskFormat

Property Type Description
id String ID of the resource. It is 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 is not assigned to anyone, or if the orderHintsByAssignee dictionary does not provide an order hint for the user the task is assigned to. The format is defined as outlined here.

plannerAssignments

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.

plannerBucketTaskBoardTaskFormat

Property Type Description
id String Read-only. ID of the resource. It is 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.

plannerCategoryDescriptions

Property Type Description
category1 String The label associated with Category 1
category2 String The label associated with Category 2
category3 String The label associated with Category 3
category4 String The label associated with Category 4
category5 String The label associated with Category 5
category6 String The label associated with Category 6
category7 String The label associated with Category 7
category8 String The label associated with Category 8
category9 String The label associated with Category 9
category10 String The label associated with Category 10
category11 String The label associated with Category 11
category12 String The label associated with Category 12
category13 String The label associated with Category 13
category14 String The label associated with Category 14
category15 String The label associated with Category 15
category16 String The label associated with Category 16
category17 String The label associated with Category 17
category18 String The label associated with Category 18
category19 String The label associated with Category 19
category20 String The label associated with Category 20
category21 String The label associated with Category 21
category22 String The label associated with Category 22
category23 String The label associated with Category 23
category24 String The label associated with Category 24
category25 String The label associated with Category 25

plannerChecklistItems

plannerExternalReferences

plannerOrderHintsByAssignee

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 is 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 is 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 is set, this property can’t be updated. This property will not return a valid group ID if the container of the plan is not a group.
title String Required. Title of the plan.

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.

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 is 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 are leveraging 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 is not required for them to access the plan owned by the group.

plannerProgressTaskBoardTaskFormat

Property Type Description
id String Read-only. ID of the resource. It is 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.

plannerRoster

Property Type Description
id String Identifier of the **p

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.

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 is 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 non-empty description and false otherwise.
id String Read-only. ID of the task. It is 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.

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 is 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.

plannerUser

Property Type Description
id String Read-only. The unique identifier for the **p

plannerUserIds

tasks-identifiers-disclaimer

In This Article
Back to top Created by merill | Submit feedback