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 (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J") |
taskId | string | No | The ID of the task to get (e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m") |
| 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 |
| 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") |
description | string | No | No description |
dueDateTime | string | No | The due date and time for the task in ISO 8601 format (e.g., "2025-03-15T17:00:00Z") |
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") |
| 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 |
| Parameter | Type | Required | Description |
|---|
taskId | string | Yes | The ID of the task to update (e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m") |
etag | string | Yes | No description |
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 | No description |
percentComplete | number | No | No description |
priority | number | No | No description |
assigneeUserId | string | No | The user ID to assign the task to (e.g., "e82f74c3-4d8a-4b5c-9f1e-2a6b8c9d0e3f") |
| 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 |
| Parameter | Type | Required | Description |
|---|
taskId | string | Yes | The ID of the task to delete (e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m") |
etag | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the task was deleted successfully |
deleted | boolean | Confirmation of deletion |
metadata | object | Additional metadata |
| 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 |
↳ count | number | Number of plans returned |
↳ userId | string | User ID |
| Parameter | Type | Required | Description |
|---|
planId | string | Yes | The ID of the plan to retrieve (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J") |
| 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 |
| Parameter | Type | Required | Description |
|---|
planId | string | Yes | The ID of the plan (e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J") |
| 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 |
| Parameter | Type | Required | Description |
|---|
bucketId | string | Yes | The ID of the bucket to retrieve (e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq") |
| 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 |
| 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 | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
bucketId | string | Yes | The ID of the bucket to update (e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq") |
name | string | No | No description |
etag | string | Yes | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
bucketId | string | Yes | The ID of the bucket to delete (e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq") |
etag | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the bucket was deleted successfully |
deleted | boolean | Confirmation of deletion |
metadata | object | Additional metadata |
| Parameter | Type | Required | Description |
|---|
taskId | string | Yes | The ID of the task (e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m") |
| 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 task details including description, checklist items, and references in Microsoft Planner
| Parameter | Type | Required | Description |
|---|
taskId | string | Yes | The ID of the task (e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m") |
etag | string | Yes | No description |
description | string | No | No description |
checklist | object | No | No description |
references | object | No | No description |
previewType | string | No | No description |
| 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 |
