Skip to main content

Microsoft Planner Connector

Microsoft Planner Manage plans, buckets, tasks, and task details in Microsoft Planner.

Connections​

OAuth 2.0 Authorization Code​

Authenticates actions in all Microsoft's Graph API services.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Base URLThe base URL for the Microsoft Graph API. Depending on your cloud environment, you can choose the correct one here.https://graph.microsoft.com
Tenant URLThe tenant URL for the Microsoft Graph API. This is the URL of the tenant that you are connecting to. You can find this in the Azure portal or here.login.microsoftonline.com/common
ScopesSpace-separated Microsoft Graph scopes. Tasks.ReadWrite covers all Planner reads and writes and offline_access is required to receive a refresh token. Add Group.Read.All to list every group in the tenant rather than only the groups the signed-in user belongs to.https://graph.microsoft.com/Tasks.ReadWrite https://graph.microsoft.com/User.Read https://graph.microsoft.com/User.ReadBasic.All offline_access
Client IDClient Id of your Azure application.
Client secret valueClient Secret generated under 'Certificates & Secrets' in your Azure application.
Additional Authorization ParametersQuery string parameters to append to the OAuth authorization URL. Common parameters include prompt=consent to force the consent screen or login_hint=user@example.com to pre-fill the login email.

OAuth 2.0 Client Credentials​

Authenticates actions in all Microsoft's Graph API services.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Base URLThe base URL for the Microsoft Graph API. Depending on your cloud environment, you can choose the correct one here.https://graph.microsoft.com
Microsoft Entra ID EndpointThe Microsoft Entra ID endpoint for the Microsoft Graph API. You can find this in the Azure portal or here.https://login.microsoftonline.com
TenantTenant ID or primary domain, found on the Overview page of the Microsoft Entra admin center. A client credentials token cannot be issued against the 'common' endpoint, so a specific tenant is required here.
Client IDClient Id of your Azure application.
Client SecretClient Secret generated under 'Certificates & Secrets' in your Azure application.
ScopesMicrosoft Graph API Scopes.https://graph.microsoft.com/.default
User IDObject ID or user principal name of the user whose Planner data is accessed, found in the Microsoft Entra admin center under Users. Required because a client credentials token has no signed-in user, so every /me path is rewritten to /users/{User ID}.

Triggers​

New Tasks​

Retrieves existing and newly created tasks for a specified Microsoft Planner plan. Load history once, check for new tasks on a schedule, or both.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Look-back DateThe date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each task created on or after this date once.

Actions​

Assign Task​

Add or remove the users assigned to a task.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Task IDThe unique identifier of the task.
AssignmentUsers to assign or unassign. At least one of Assign To or Unassign is required.
Assign ToUsers to assign to the task, identified by object ID. Existing assignees that are not listed here are left in place.[]
UnassignUsers to remove from the task, identified by object ID.[]
ETagThe last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed.

Complete Task​

Mark a task as complete.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Task IDThe unique identifier of the task.
ETagThe last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed.

Create Bucket​

Create a bucket in a plan.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
NameThe name of the bucket, shown as a column heading on the plan's board.

Create Plan​

Create a plan inside a Microsoft 365 group. The caller must already be a member of that group; creating a group does not add its creator as a member, which is a common cause of a permissions error here.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group that holds the plan. Only Microsoft 365 groups can contain Planner plans.
TitleThe title of the plan, shown wherever the plan is listed.

Create Task​

Create a task in a plan. Supplying a description performs a second write, because a task's description is stored on its details resource and cannot be set when the task is created.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
TitleThe title of the task, shown on its card in the Planner board.
Bucket IDThe unique identifier of the bucket to create the task in. Leave blank to create the task without assigning it to a bucket.
AssignmentUsers to assign or unassign.
Assign ToUsers to assign to the task, identified by object ID. Existing assignees that are not listed here are left in place.[]
UnassignUsers to remove from the task, identified by object ID.[]
ScheduleStart and due timestamps.
Start AtThe timestamp the task starts, in ISO 8601 format.
Due AtThe timestamp the task is due, in ISO 8601 format.
PriorityThe priority of the task. Planner stores priority as a number from 0 to 10 and displays it in four bands, so these four values are the ones the Planner interface itself uses.
Percent CompleteHow complete the task is, from 0 to 100. Planner has no separate completed flag: setting this to 100 completes the task, and the service fills in who completed it and when.
CategoriesColored categories to apply or remove.
ApplyColored categories to apply to the task. The label shown for each category is configured on the plan.[]
RemoveColored categories to remove from the task.[]
DescriptionThe description of the task. Descriptions live on the task's details resource rather than the task itself, so setting one is a separate write.

Delete Bucket​

Delete a bucket and the tasks it contains.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Bucket IDThe unique identifier of the bucket.
ETagThe last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed.

Delete Plan​

Delete a plan and everything it contains.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
ETagThe last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed.

Delete Task​

Delete a task.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Task IDThe unique identifier of the task.
ETagThe last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed.

Get Bucket​

Retrieve a single bucket by its ID.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Bucket IDThe unique identifier of the bucket.

Get Plan​

Retrieve a single plan by its ID.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.

Get Plan Details​

Retrieve a plan's category labels and shared-with list.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.

Get Task​

Retrieve a single task by its ID.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Task IDThe unique identifier of the task.

Get Task Details​

Retrieve a task's description, checklist, and links.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Task IDThe unique identifier of the task.

List Buckets in Plan​

List every bucket in a plan.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.

List Plans for User​

List the plans shared with the user.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.

List Plans in Group​

List every plan contained by a Microsoft 365 group.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group that holds the plan. Only Microsoft 365 groups can contain Planner plans.

List Tasks for User​

List every task assigned to the user, across every plan.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.

List Tasks in Bucket​

List every task in a single bucket.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Bucket IDThe unique identifier of the bucket.

List Tasks in Plan​

List every task in a plan, across all of its buckets.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.

Move Task to Bucket​

Move a task into a different bucket. The destination bucket must belong to the same plan as the task.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Task IDThe unique identifier of the task.
Bucket IDThe unique identifier of the bucket.
ETagThe last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed.

Raw Request​

Send a raw HTTP request to the Microsoft Graph API.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
URLThe path of the Microsoft Graph endpoint to call (e.g., /planner/plans). The base URL https://graph.microsoft.com/v1.0 is added automatically. Planner endpoints that modify or delete a resource require an If-Match header carrying the resource's current ETag.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.[]
File DataFile Data to be sent as a multipart form upload.[]
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.[]
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.[]
HeaderA list of headers to send with the request.[]
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Update Bucket​

Rename a bucket. A bucket cannot be moved to a different plan.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Bucket IDThe unique identifier of the bucket.
NameThe name of the bucket, shown as a column heading on the plan's board.
ETagThe last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed.

Update Plan​

Rename a plan. The title is the only property a plan allows changing.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
TitleThe title of the plan, shown wherever the plan is listed.
ETagThe last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed.

Update Plan Details​

Set a plan's category labels and adjust who it is shared with.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Category LabelsLabels for the plan's colored categories, keyed by category1 through category25. Only the categories listed here change; leave a category out to keep its current label.[]
SharingUsers to add to or remove from the shared-with list.
Share WithUsers to add to the plan's shared-with list, identified by object ID. For a plan contained by a Microsoft 365 group, managing group membership is usually preferable to sharing individually.[]
Unshare WithUsers to remove from the plan's shared-with list, identified by object ID.[]
Plan Details ETagThe last known ETag of the plan details. Plan details carry their own ETag, separate from the plan's, so a plan ETag cannot be used here. Leave blank to read the current value before writing.

Update Task​

Update a task's properties. Only the fields supplied are changed; everything else keeps its current value.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Task IDThe unique identifier of the task.
TitleA new title for the task. Leave blank to keep the current title.
Bucket IDThe unique identifier of the bucket. Leave blank to leave the task in its current bucket.
AssignmentUsers to assign or unassign.
Assign ToUsers to assign to the task, identified by object ID. Existing assignees that are not listed here are left in place.[]
UnassignUsers to remove from the task, identified by object ID.[]
ScheduleStart and due timestamps.
Start AtThe timestamp the task starts, in ISO 8601 format.
Due AtThe timestamp the task is due, in ISO 8601 format.
PriorityThe priority of the task. Planner stores priority as a number from 0 to 10 and displays it in four bands, so these four values are the ones the Planner interface itself uses.
Percent CompleteHow complete the task is, from 0 to 100. Planner has no separate completed flag: setting this to 100 completes the task, and the service fills in who completed it and when.
CategoriesColored categories to apply or remove.
ApplyColored categories to apply to the task. The label shown for each category is configured on the plan.[]
RemoveColored categories to remove from the task.[]
Conversation Thread IDThe identifier of the group conversation thread associated with the task.
ETagThe last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed.

Update Task Details​

Set a task's description, checklist items, and external links.

InputCommentsDefault
ConnectionThe Microsoft Planner connection to use.
Group IDThe Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead.
Plan IDThe unique identifier of the plan.
Task IDThe unique identifier of the task.
DescriptionThe description of the task. Descriptions live on the task's details resource rather than the task itself, so setting one is a separate write.
ChecklistChecklist items to add or remove.
Add ItemsChecklist items to add, where the key is the item title and the value is true if the item starts checked.[]
Remove ItemsIdentifiers of checklist items to remove. Use the Get Task Details action to read the current item identifiers.[]
LinksExternal links to attach or remove.
AddExternal links to attach to the task, where the key is the URL and the value is the display name shown in Planner.[]
RemoveURLs of external links to remove from the task.[]
Preview TypeWhich part of the task details is shown on the task's card in the Planner board.
Task Details ETagThe last known ETag of the task details. Task details carry their own ETag, separate from the task's, so a task ETag cannot be used here. Leave blank to read the current value before writing.