Tools
Microsoft Planner
Manage tasks, plans, and buckets in Microsoft Planner
Integrate Microsoft Planner into the workflow. Manage tasks, plans, buckets, and task details including checklists and references.
Read tasks from Microsoft Planner - get all user tasks or all tasks from a specific plan
| Parameter | Type | Required | Description |
|---|
planId | string | No | The ID of the plan to get tasks from (if not provided, gets all user tasks) |
taskId | string | No | The ID of the task to get |
| 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 |
Create a new task in Microsoft Planner
| Parameter | Type | Required | Description |
|---|
planId | string | Yes | The ID of the plan where the task will be created |
title | string | Yes | The title of the task |
description | string | No | The description of the task |
dueDateTime | string | No | The due date and time for the task (ISO 8601 format) |
assigneeUserId | string | No | The user ID to assign the task to |
bucketId | string | No | The bucket ID to place the task in |
| 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 |
Update a task in Microsoft Planner
| Parameter | Type | Required | Description |
|---|
taskId | string | Yes | The ID of the task to update |
etag | string | Yes | The ETag value from the task to update (If-Match header) |
title | string | No | The new title of the task |
bucketId | string | No | The bucket ID to move the task to |
dueDateTime | string | No | The due date and time for the task (ISO 8601 format) |
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 |
| 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 |
Delete a task from Microsoft Planner
| Parameter | Type | Required | Description |
|---|
taskId | string | Yes | The ID of the task to delete |
etag | string | Yes | The ETag value from the task to delete (If-Match header) |
| Parameter | Type | Description |
|---|
success | boolean | Whether the task was deleted successfully |
deleted | boolean | Confirmation of deletion |
metadata | object | Additional metadata |
List all plans shared with the current user
| Parameter | Type | Required | Description |
|---|
| 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 |
Get details of a specific Microsoft Planner plan
| Parameter | Type | Required | Description |
|---|
planId | string | Yes | The ID of the plan to retrieve |
| 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 |
List all buckets in a Microsoft Planner plan
| Parameter | Type | Required | Description |
|---|
planId | string | Yes | The ID of the plan |
| Parameter | Type | Description |
|---|
success | boolean | Whether buckets were retrieved successfully |
buckets | array | Array of bucket objects |
metadata | object | Metadata including planId and count |
Get details of a specific bucket
| Parameter | Type | Required | Description |
|---|
bucketId | string | Yes | The ID of the bucket to retrieve |
| 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 |
Create a new bucket in a Microsoft Planner plan
| Parameter | Type | Required | Description |
|---|
planId | string | Yes | The ID of the plan where the bucket will be created |
name | string | Yes | The name of the bucket |
| 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 |
Update a bucket in Microsoft Planner
| Parameter | Type | Required | Description |
|---|
bucketId | string | Yes | The ID of the bucket to update |
name | string | No | The new name of the bucket |
etag | string | Yes | The ETag value from the bucket to update (If-Match header) |
| 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 |
Delete a bucket from Microsoft Planner
| Parameter | Type | Required | Description |
|---|
bucketId | string | Yes | The ID of the bucket to delete |
etag | string | Yes | The ETag value from the bucket to delete (If-Match header) |
| Parameter | Type | Description |
|---|
success | boolean | Whether the bucket was deleted successfully |
deleted | boolean | Confirmation of deletion |
metadata | object | Additional metadata |
Get detailed information about a task including checklist and references
| Parameter | Type | Required | Description |
|---|
taskId | string | Yes | The ID of the task |
| 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 |
Update task details including description, checklist items, and references in Microsoft Planner
| Parameter | Type | Required | Description |
|---|
taskId | string | Yes | The ID of the task |
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 |
| 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 |
- Category:
tools
- Type:
microsoft_planner