Microsoft Planner

Use Microsoft Planner to manage tasks, plans, and buckets. Task details include checklists and references; use the actions below to read or update them.

OAuth scopes

Sim requests these scopes when someone connects a Microsoft Planner account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.

Use the block

Manage tasks, plans, buckets, and task details including checklists and references.

Actions

Read Microsoft Planner Tasks

Read tasks from Microsoft Planner - get all user tasks or all tasks from a specific plan

Inputs and outputs

Input

Parameter	Type	Required	Description
planId	string	No	The ID of the plan to get tasks from, if not provided gets all user tasks (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J")
taskId	string	No	The ID of the task to get (e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m")

Output

Parameter	Type	Description
success	boolean	Whether tasks were retrieved successfully
tasks	array	Array of task objects with filtered properties
metadata	object	Metadata including planId, userId, and planUrl
↳ planId	string	Plan ID
↳ userId	string	User ID
↳ planUrl	string	Microsoft Graph API URL for the plan

Create Microsoft Planner Task

Create a new task in Microsoft Planner

Inputs and outputs

Input

Parameter	Type	Required	Description
planId	string	Yes	The ID of the plan where the task will be created (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J")
title	string	Yes	The title of the task (e.g., "Review quarterly report")
dueDateTime	string	No	The due date and time for the task in ISO 8601 format (e.g., "2025-03-15T17:00:00Z")
startDateTime	string	No	The start date and time for the task in ISO 8601 format (e.g., "2025-03-10T09:00:00Z")
priority	number	No	The priority of the task (0-10, where 0 is urgent and 10 is low)
percentComplete	number	No	The percentage of task completion (0-100)
assigneeUserId	string	No	The user ID to assign the task to (e.g., "e82f74c3-4d8a-4b5c-9f1e-2a6b8c9d0e3f")
bucketId	string	No	The bucket ID to place the task in (e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq")
appliedCategories	string	No	Comma-separated category labels to apply to the task, e.g. "category1,category3" (up to category1-category25, plan-defined color labels)

Output

Parameter	Type	Description
success	boolean	Whether the task was created successfully
task	object	The created task object with all properties
metadata	object	Metadata including planId, taskId, and taskUrl
↳ planId	string	Parent plan ID
↳ taskId	string	Created task ID
↳ taskUrl	string	Microsoft Graph API URL for the task

Update Microsoft Planner Task

Update a task in Microsoft Planner

Inputs and outputs

Input

Parameter	Type	Required	Description
taskId	string	Yes	The ID of the task to update (e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m")
etag	string	Yes	The ETag value from the task to update (If-Match header)
title	string	No	The new title of the task (e.g., "Review quarterly report")
bucketId	string	No	The bucket ID to move the task to (e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq")
dueDateTime	string	No	The due date and time for the task in ISO 8601 format (e.g., "2025-03-15T17:00:00Z")
startDateTime	string	No	The start date and time for the task (ISO 8601 format)
percentComplete	number	No	The percentage of task completion (0-100)
priority	number	No	The priority of the task (0-10)
assigneeUserId	string	No	The user ID to assign the task to (e.g., "e82f74c3-4d8a-4b5c-9f1e-2a6b8c9d0e3f")
appliedCategories	string	No	Comma-separated category labels to apply to the task, e.g. "category1,category3" (up to category1-category25, plan-defined color labels)

Output

Parameter	Type	Description
success	boolean	Whether the task was updated successfully
message	string	Success message when task is updated
task	object	The updated task object with all properties
taskId	string	ID of the updated task
etag	string	New ETag after update - use this for subsequent operations
metadata	object	Metadata including taskId, planId, and taskUrl
↳ taskId	string	Updated task ID
↳ planId	string	Parent plan ID
↳ taskUrl	string	Microsoft Graph API URL for the task

Delete Microsoft Planner Task

Delete a task from Microsoft Planner

Inputs and outputs

Input

Parameter	Type	Required	Description
taskId	string	Yes	The ID of the task to delete (e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m")
etag	string	Yes	The ETag value from the task to delete (If-Match header)

Output

Parameter	Type	Description
success	boolean	Whether the task was deleted successfully
deleted	boolean	Confirmation of deletion
metadata	object	Additional metadata

List Microsoft Planner Plans

List all plans shared with the current user

Inputs and outputs

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
success	boolean	Whether plans were retrieved successfully
plans	array	Array of plan objects shared with the current user
metadata	object	Metadata including userId and count
↳ count	number	Number of plans returned
↳ userId	string	User ID

Read Microsoft Planner Plan

Get details of a specific Microsoft Planner plan

Inputs and outputs

Input

Parameter	Type	Required	Description
planId	string	Yes	The ID of the plan to retrieve (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J")

Output

Parameter	Type	Description
success	boolean	Whether the plan was retrieved successfully
plan	object	The plan object with all properties
metadata	object	Metadata including planId and planUrl
↳ planId	string	Plan ID
↳ planUrl	string	Microsoft Graph API URL for the plan

Create Microsoft Planner Plan

Create a new Microsoft Planner plan owned by a Microsoft 365 group

Inputs and outputs

Input

Parameter	Type	Required	Description
groupId	string	Yes	The ID of the Microsoft 365 group that will own the plan (e.g., "ebf3b108-5234-4e22-b93d-656d7dae5874"). The current user must be a member of this group.
title	string	Yes	The title of the plan

Output

Parameter	Type	Description
success	boolean	Whether the plan was created successfully
plan	object	The created plan object with all properties
metadata	object	Metadata including planId and groupId
↳ planId	string	Created plan ID
↳ groupId	string	Owning Microsoft 365 group ID

Update Microsoft Planner Plan

Rename a Microsoft Planner plan

Inputs and outputs

Input

Parameter	Type	Required	Description
planId	string	Yes	The ID of the plan to update (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J")
etag	string	Yes	The ETag value from the plan to update (If-Match header)
title	string	Yes	The new title of the plan

Output

Parameter	Type	Description
success	boolean	Whether the plan was updated successfully
plan	object	The updated plan object with all properties
metadata	object	Metadata including planId
↳ planId	string	Updated plan ID

Get Microsoft Planner Plan Details

Get detailed information about a plan including category descriptions and sharing

Inputs and outputs

Input

Parameter	Type	Required	Description
planId	string	Yes	The ID of the plan (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J")

Output

Parameter	Type	Description
success	boolean	Whether the plan details were retrieved successfully
planDetails	object	The plan details including categoryDescriptions and sharedWith
etag	string	The ETag value for this plan details resource
metadata	object	Metadata including planId
↳ planId	string	Plan ID

Update Microsoft Planner Plan Details

Update a plan's category (color label) descriptions and shared-with user list in Microsoft Planner

Inputs and outputs

Input

Parameter	Type	Required	Description
planId	string	Yes	The ID of the plan (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J")
etag	string	Yes	The ETag value from the plan details to update (If-Match header)
categoryDescriptions	object	No	Category label names as a JSON object, e.g. {"category1": "Blocked", "category2": "At Risk"}. Set a value to null to clear a label.
sharedWith	object	No	User IDs to share the plan with as a JSON object, e.g. {"<user-id>": true}. Set a value to false to unshare.

Output

Parameter	Type	Description
success	boolean	Whether the plan details were updated successfully
planDetails	object	The updated plan details object with categoryDescriptions and sharedWith
metadata	object	Metadata including planId
↳ planId	string	Plan ID

Delete Microsoft Planner Plan

Delete a Microsoft Planner plan

Inputs and outputs

Input

Parameter	Type	Required	Description
planId	string	Yes	The ID of the plan to delete (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J")
etag	string	Yes	The ETag value from the plan to delete (If-Match header)

Output

Parameter	Type	Description
success	boolean	Whether the plan was deleted successfully
deleted	boolean	Confirmation of deletion
metadata	object	Additional metadata

List Microsoft Planner Buckets

List all buckets in a Microsoft Planner plan

Inputs and outputs

Input

Parameter	Type	Required	Description
planId	string	Yes	The ID of the plan (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J")

Output

Parameter	Type	Description
success	boolean	Whether buckets were retrieved successfully
buckets	array	Array of bucket objects
metadata	object	Metadata including planId and count
↳ planId	string	Plan ID
↳ count	number	Number of buckets returned

Read Microsoft Planner Bucket

Get details of a specific bucket

Inputs and outputs

Input

Parameter	Type	Required	Description
bucketId	string	Yes	The ID of the bucket to retrieve (e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq")

Output

Parameter	Type	Description
success	boolean	Whether the bucket was retrieved successfully
bucket	object	The bucket object with all properties
metadata	object	Metadata including bucketId and planId
↳ bucketId	string	Bucket ID
↳ planId	string	Parent plan ID

Create Microsoft Planner Bucket

Create a new bucket in a Microsoft Planner plan

Inputs and outputs

Input

Parameter	Type	Required	Description
planId	string	Yes	The ID of the plan where the bucket will be created (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J")
name	string	Yes	The name of the bucket

Output

Parameter	Type	Description
success	boolean	Whether the bucket was created successfully
bucket	object	The created bucket object with all properties
metadata	object	Metadata including bucketId and planId
↳ bucketId	string	Created bucket ID
↳ planId	string	Parent plan ID

Update Microsoft Planner Bucket

Update a bucket in Microsoft Planner

Inputs and outputs

Input

Parameter	Type	Required	Description
bucketId	string	Yes	The ID of the bucket to update (e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq")
name	string	No	The new name of the bucket
etag	string	Yes	The ETag value from the bucket to update (If-Match header)

Output

Parameter	Type	Description
success	boolean	Whether the bucket was updated successfully
bucket	object	The updated bucket object with all properties
metadata	object	Metadata including bucketId and planId
↳ bucketId	string	Updated bucket ID
↳ planId	string	Parent plan ID

Delete Microsoft Planner Bucket

Delete a bucket from Microsoft Planner

Inputs and outputs

Input

Parameter	Type	Required	Description
bucketId	string	Yes	The ID of the bucket to delete (e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq")
etag	string	Yes	The ETag value from the bucket to delete (If-Match header)

Output

Parameter	Type	Description
success	boolean	Whether the bucket was deleted successfully
deleted	boolean	Confirmation of deletion
metadata	object	Additional metadata

Get Microsoft Planner Task Details

Get detailed information about a task including checklist and references

Inputs and outputs

Input

Parameter	Type	Required	Description
taskId	string	Yes	The ID of the task (e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m")

Output

Parameter	Type	Description
success	boolean	Whether the task details were retrieved successfully
taskDetails	object	The task details including description, checklist, and references
etag	string	The ETag value for this task details - use this for update operations
metadata	object	Metadata including taskId
↳ taskId	string	Task ID

Update Microsoft Planner Task Details

Update task details including description, checklist items, and references in Microsoft Planner

Inputs and outputs

Input

Parameter	Type	Required	Description
taskId	string	Yes	The ID of the task (e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m")
etag	string	Yes	The ETag value from the task details to update (If-Match header)
description	string	No	The description of the task
checklist	object	No	Checklist items as a JSON object
references	object	No	References as a JSON object
previewType	string	No	Preview type: automatic, noPreview, checklist, description, or reference

Output

Parameter	Type	Description
success	boolean	Whether the task details were updated successfully
taskDetails	object	The updated task details object with all properties
metadata	object	Metadata including taskId
↳ taskId	string	Task ID