Microsoft Planner

App · Project Management · 20 actions

Create and manage Microsoft Planner plans, buckets and tasks: assign people, set dates, priorities and labels, and keep checklists up to date.

Actions

ActionWhat it does
Create bucketAdd a bucket (board column) to a plan.
Create planCreate a plan in a Microsoft 365 group you are a member of.
Create taskCreate a task in a plan, optionally in a bucket, with dates, priority, labels and assignees.
Delete bucketDelete a bucket and the tasks in it.
Delete planDelete a plan with all of its buckets and tasks.
Delete taskDelete a task.
Get planGet a plan's title, group and creator.
Get plan detailsGet a plan's label names and the people it is shared with.
Get taskGet a task's title, dates, progress, priority, assignees and labels.
Get task detailsGet a task's description, checklist and attachments.
List bucketsList the buckets (board columns) in a plan.
List group plansList the plans that belong to a Microsoft 365 group.
List my groupsList the Microsoft 365 groups you belong to.
List my plansList the plans shared with you.
List my tasksList the Planner tasks assigned to you, across every plan.
List plan tasksList the tasks in a plan, optionally only those in one bucket.
Rename bucketChange a bucket's name.
Rename planChange a plan's title.
Update taskChange a task: rename it, move it to another bucket, change its dates, priority or progress, assign or unassign people, and add or remove labels.
Update task detailsChange a task's description, add checklist items, tick, untick or remove existing ones, and choose what its card shows.

Create bucket

Add a bucket (board column) to a plan. It appears first on the board.

Inputs

Planplan_idtextRequired
The plan. Pick one, or paste its id or a link to it from Planner.
NamenametextRequired
The bucket's name.

Outputs

idtext
nametext
orderHinttext
planIdtext
Example output
{
  "id": "hsOf2dhOJkqyYYZEtdzDe2QAIUCR",
  "name": "To do",
  "orderHint": "85752723360752+",
  "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM"
}

Create plan

Create a plan in a Microsoft 365 group you are a member of.

Inputs

Groupgroup_idtextRequired
The Microsoft 365 group the plan belongs to. Pick one, or paste the group's Object ID.
TitletitletextRequired
The plan's name.

Outputs

containerobject
createdByobject
createdDateTimetext
created_by_user_idtext
group_idtext
idtext
ownertext
titletext
Example output
{
  "container": {
    "containerId": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
    "type": "group",
    "url": "https://graph.microsoft.com/v1.0/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315"
  },
  "createdBy": {
    "user": {
      "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
    }
  },
  "createdDateTime": "2026-09-01T10:00:00Z",
  "created_by_user_id": "6463a5ce-2119-4198-9f2a-628761df4a62",
  "group_id": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
  "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "owner": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
  "title": "Launch plan"
}

Create task

Create a task in a plan, optionally in a bucket, with dates, priority, labels and assignees.

Inputs

Planplan_idtextRequired
The plan. Pick one, or paste its id or a link to it from Planner.
TitletitletextRequired
The task's title.
Bucketbucket_idtext
The bucket to put the task in. Leave empty for the plan's default bucket.
Assign to meassign_to_metrue/false
Assign the task to the account this connection signed in with.
Assign toassign_user_idslist
Microsoft Entra object IDs of the people to assign. They must be members of the plan's group.
Start datestart_datedate
When work on the task starts.
Due datedue_datedate
When the task is due.
Priorityprioritytext
The task's priority.One of: urgent, important, medium, low.
Progressprogresstext
The task's progress. Completed marks the task done.One of: not_started (Not started), in_progress (In progress), completed.
Labelscategorieslist
Labels to apply. Get plan details shows what each label is called in this plan.One or more of: category1 (Label 1), category2 (Label 2), category3 (Label 3), category4 (Label 4), category5 (Label 5), category6 (Label 6), category7 (Label 7), category8 (Label 8), category9 (Label 9), category10 (Label 10), and 15 more.

Outputs

activeChecklistItemCountnumber
appliedCategoriesobject
assigneePrioritytext
assignee_idslist
assignmentsobject
bucketIdtext
categorieslist
checklistItemCountnumber
completedByobject
completedDateTimetext
conversationThreadIdtext
createdByobject
createdDateTimetext
dueDateTimetext
hasDescriptiontrue/false
idtext
is_completedtrue/false
orderHinttext
percentCompletenumber
planIdtext
previewTypetext
prioritynumber
priority_labeltext
progresstext
referenceCountnumber
startDateTimetext
titletext
Example output
{
  "activeChecklistItemCount": 0,
  "appliedCategories": {
    "category1": true
  },
  "assignee_ids": [
    "6463a5ce-2119-4198-9f2a-628761df4a62"
  ],
  "assignments": {
    "6463a5ce-2119-4198-9f2a-628761df4a62": {
      "assignedBy": {},
      "orderHint": "8585"
    }
  },
  "bucketId": "hsOf2dhOJkqyYYZEtdzDe2QAIUCR",
  "categories": [
    "category1"
  ],
  "checklistItemCount": 0,
  "createdBy": {
    "user": {
      "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
    }
  },
  "createdDateTime": "2026-09-01T10:05:00Z",
  "dueDateTime": "2026-10-01T12:00:00Z",
  "hasDescription": false,
  "id": "01gzSlKkIUSUl6DF_EilrmQAKDhh",
  "is_completed": false,
  "percentComplete": 0,
  "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "previewType": "automatic",
  "priority": 3,
  "priority_label": "important",
  "progress": "not_started",
  "referenceCount": 0,
  "startDateTime": null,
  "title": "Draft the announcement"
}

Delete bucket

Delete a bucket and the tasks in it. This cannot be undone.

Inputs

Bucketbucket_idtextRequired
The bucket's id. Use List buckets to find one.

Outputs

bucket_idtext
deletedtrue/false
Example output
{
  "bucket_id": "hsOf2dhOJkqyYYZEtdzDe2QAIUCR",
  "deleted": true
}

Delete plan

Delete a plan with all of its buckets and tasks. This cannot be undone.

Inputs

Planplan_idtextRequired
The plan. Pick one, or paste its id or a link to it from Planner.

Outputs

deletedtrue/false
plan_idtext
Example output
{
  "deleted": true,
  "plan_id": "xqQg5FS2LkCp935s-FIFm2QAFkHM"
}

Delete task

Delete a task. This cannot be undone.

Inputs

Tasktask_idtextRequired
The task's id (use List plan tasks to find one), or a link to the task copied from Planner.

Outputs

deletedtrue/false
task_idtext
Example output
{
  "deleted": true,
  "task_id": "01gzSlKkIUSUl6DF_EilrmQAKDhh"
}

Get plan

Get a plan's title, group and creator.

Inputs

Planplan_idtextRequired
The plan. Pick one, or paste its id or a link to it from Planner.

Outputs

containerobject
createdByobject
createdDateTimetext
created_by_user_idtext
group_idtext
idtext
ownertext
titletext
Example output
{
  "container": {
    "containerId": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
    "type": "group",
    "url": "https://graph.microsoft.com/v1.0/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315"
  },
  "createdBy": {
    "user": {
      "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
    }
  },
  "createdDateTime": "2026-09-01T10:00:00Z",
  "created_by_user_id": "6463a5ce-2119-4198-9f2a-628761df4a62",
  "group_id": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
  "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "owner": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
  "title": "Launch plan"
}

Get plan details

Get a plan's label names and the people it is shared with.

Inputs

Planplan_idtextRequired
The plan. Pick one, or paste its id or a link to it from Planner.

Outputs

categoryDescriptionsobject
idtext
labelslist
member_idslist
sharedWithobject
Example output
{
  "categoryDescriptions": {
    "category1": "Blocked"
  },
  "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "labels": [
    {
      "category": "category1",
      "name": "Blocked"
    }
  ],
  "member_ids": [
    "6463a5ce-2119-4198-9f2a-628761df4a62"
  ],
  "sharedWith": {
    "6463a5ce-2119-4198-9f2a-628761df4a62": true
  }
}

Get task

Get a task's title, dates, progress, priority, assignees and labels.

Inputs

Tasktask_idtextRequired
The task's id (use List plan tasks to find one), or a link to the task copied from Planner.

Outputs

activeChecklistItemCountnumber
appliedCategoriesobject
assigneePrioritytext
assignee_idslist
assignmentsobject
bucketIdtext
categorieslist
checklistItemCountnumber
completedByobject
completedDateTimetext
conversationThreadIdtext
createdByobject
createdDateTimetext
dueDateTimetext
hasDescriptiontrue/false
idtext
is_completedtrue/false
orderHinttext
percentCompletenumber
planIdtext
previewTypetext
prioritynumber
priority_labeltext
progresstext
referenceCountnumber
startDateTimetext
titletext
Example output
{
  "activeChecklistItemCount": 0,
  "appliedCategories": {
    "category1": true
  },
  "assignee_ids": [
    "6463a5ce-2119-4198-9f2a-628761df4a62"
  ],
  "assignments": {
    "6463a5ce-2119-4198-9f2a-628761df4a62": {
      "assignedBy": {},
      "orderHint": "8585"
    }
  },
  "bucketId": "hsOf2dhOJkqyYYZEtdzDe2QAIUCR",
  "categories": [
    "category1"
  ],
  "checklistItemCount": 0,
  "createdBy": {
    "user": {
      "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
    }
  },
  "createdDateTime": "2026-09-01T10:05:00Z",
  "dueDateTime": "2026-10-01T12:00:00Z",
  "hasDescription": false,
  "id": "01gzSlKkIUSUl6DF_EilrmQAKDhh",
  "is_completed": false,
  "percentComplete": 0,
  "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "previewType": "automatic",
  "priority": 3,
  "priority_label": "important",
  "progress": "not_started",
  "referenceCount": 0,
  "startDateTime": null,
  "title": "Draft the announcement"
}

Get task details

Get a task's description, checklist and attachments.

Inputs

Tasktask_idtextRequired
The task's id (use List plan tasks to find one), or a link to the task copied from Planner.

Outputs

checklistobject
checklist_itemslist
descriptiontext
idtext
previewTypetext
referencesobject
Example output
{
  "checklist": {
    "95e27074-6c4a-447a-aa24-9d718a0b86fa": {
      "isChecked": false,
      "orderHint": "85752723",
      "title": "Write the draft"
    }
  },
  "checklist_items": [
    {
      "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa",
      "isChecked": false,
      "title": "Write the draft"
    }
  ],
  "description": "Announce the launch on the blog.",
  "id": "01gzSlKkIUSUl6DF_EilrmQAKDhh",
  "previewType": "checklist",
  "references": {}
}

List buckets

List the buckets (board columns) in a plan.

Inputs

Planplan_idtextRequired
The plan. Pick one, or paste its id or a link to it from Planner.

Outputs

bucketslist
countnumber
Example output
{
  "buckets": [
    {
      "id": "hsOf2dhOJkqyYYZEtdzDe2QAIUCR",
      "name": "To do",
      "orderHint": "85752723360752+",
      "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM"
    }
  ],
  "count": 1
}

List group plans

List the plans that belong to a Microsoft 365 group.

Inputs

Groupgroup_idtextRequired
The Microsoft 365 group the plan belongs to. Pick one, or paste the group's Object ID.

Outputs

countnumber
planslist
Example output
{
  "count": 1,
  "plans": [
    {
      "container": {
        "containerId": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
        "type": "group",
        "url": "https://graph.microsoft.com/v1.0/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315"
      },
      "createdBy": {
        "user": {
          "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
        }
      },
      "createdDateTime": "2026-09-01T10:00:00Z",
      "created_by_user_id": "6463a5ce-2119-4198-9f2a-628761df4a62",
      "group_id": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
      "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
      "owner": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
      "title": "Launch plan"
    }
  ]
}

List my groups

List the Microsoft 365 groups you belong to. A plan always lives in one.

Inputs

None.

Outputs

countnumber
groupslist
Example output
{
  "count": 1,
  "groups": [
    {
      "description": "Marketing team",
      "displayName": "Marketing",
      "id": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
      "mail": "marketing@contoso.com",
      "visibility": "Private"
    }
  ]
}

List my plans

List the plans shared with you.

Inputs

None.

Outputs

countnumber
planslist
Example output
{
  "count": 1,
  "plans": [
    {
      "container": {
        "containerId": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
        "type": "group",
        "url": "https://graph.microsoft.com/v1.0/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315"
      },
      "createdBy": {
        "user": {
          "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
        }
      },
      "createdDateTime": "2026-09-01T10:00:00Z",
      "created_by_user_id": "6463a5ce-2119-4198-9f2a-628761df4a62",
      "group_id": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
      "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
      "owner": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
      "title": "Launch plan"
    }
  ]
}

List my tasks

List the Planner tasks assigned to you, across every plan.

Inputs

None.

Outputs

countnumber
taskslist
Example output
{
  "count": 1,
  "tasks": [
    {
      "activeChecklistItemCount": 0,
      "appliedCategories": {
        "category1": true
      },
      "assignee_ids": [
        "6463a5ce-2119-4198-9f2a-628761df4a62"
      ],
      "assignments": {
        "6463a5ce-2119-4198-9f2a-628761df4a62": {
          "assignedBy": {},
          "orderHint": "8585"
        }
      },
      "bucketId": "hsOf2dhOJkqyYYZEtdzDe2QAIUCR",
      "categories": [
        "category1"
      ],
      "checklistItemCount": 0,
      "createdBy": {
        "user": {
          "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
        }
      },
      "createdDateTime": "2026-09-01T10:05:00Z",
      "dueDateTime": "2026-10-01T12:00:00Z",
      "hasDescription": false,
      "id": "01gzSlKkIUSUl6DF_EilrmQAKDhh",
      "is_completed": false,
      "percentComplete": 0,
      "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
      "previewType": "automatic",
      "priority": 3,
      "priority_label": "important",
      "progress": "not_started",
      "referenceCount": 0,
      "startDateTime": null,
      "title": "Draft the announcement"
    }
  ]
}

List plan tasks

List the tasks in a plan, optionally only those in one bucket.

Inputs

Planplan_idtextRequired
The plan. Pick one, or paste its id or a link to it from Planner.
Bucketbucket_idtext
Only list tasks in this bucket. Leave empty for all.

Outputs

countnumber
taskslist
Example output
{
  "count": 1,
  "tasks": [
    {
      "activeChecklistItemCount": 0,
      "appliedCategories": {
        "category1": true
      },
      "assignee_ids": [
        "6463a5ce-2119-4198-9f2a-628761df4a62"
      ],
      "assignments": {
        "6463a5ce-2119-4198-9f2a-628761df4a62": {
          "assignedBy": {},
          "orderHint": "8585"
        }
      },
      "bucketId": "hsOf2dhOJkqyYYZEtdzDe2QAIUCR",
      "categories": [
        "category1"
      ],
      "checklistItemCount": 0,
      "createdBy": {
        "user": {
          "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
        }
      },
      "createdDateTime": "2026-09-01T10:05:00Z",
      "dueDateTime": "2026-10-01T12:00:00Z",
      "hasDescription": false,
      "id": "01gzSlKkIUSUl6DF_EilrmQAKDhh",
      "is_completed": false,
      "percentComplete": 0,
      "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
      "previewType": "automatic",
      "priority": 3,
      "priority_label": "important",
      "progress": "not_started",
      "referenceCount": 0,
      "startDateTime": null,
      "title": "Draft the announcement"
    }
  ]
}

Rename bucket

Change a bucket's name.

Inputs

Bucketbucket_idtextRequired
The bucket's id. Use List buckets to find one.
New namenametextRequired
The bucket's new name.

Outputs

idtext
nametext
orderHinttext
planIdtext
Example output
{
  "id": "hsOf2dhOJkqyYYZEtdzDe2QAIUCR",
  "name": "To do",
  "orderHint": "85752723360752+",
  "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM"
}

Rename plan

Change a plan's title.

Inputs

Planplan_idtextRequired
The plan. Pick one, or paste its id or a link to it from Planner.
New titletitletextRequired
The plan's new name.

Outputs

containerobject
createdByobject
createdDateTimetext
created_by_user_idtext
group_idtext
idtext
ownertext
titletext
Example output
{
  "container": {
    "containerId": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
    "type": "group",
    "url": "https://graph.microsoft.com/v1.0/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315"
  },
  "createdBy": {
    "user": {
      "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
    }
  },
  "createdDateTime": "2026-09-01T10:00:00Z",
  "created_by_user_id": "6463a5ce-2119-4198-9f2a-628761df4a62",
  "group_id": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
  "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "owner": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
  "title": "Launch plan"
}

Update task

Change a task: rename it, move it to another bucket, change its dates, priority or progress, assign or unassign people, and add or remove labels. Only the fields you fill in change.

Inputs

Tasktask_idtextRequired
The task's id (use List plan tasks to find one), or a link to the task copied from Planner.
New titletitletext
The task's new title.
Move to bucketbucket_idtext
The id of a bucket in the same plan to move the task to.
Start datestart_datedate
When work on the task starts.
Due datedue_datedate
When the task is due.
Remove start dateclear_start_datetrue/false
Remove the task's start date.
Remove due dateclear_due_datetrue/false
Remove the task's due date.
Priorityprioritytext
The task's priority.One of: urgent, important, medium, low.
Progressprogresstext
The task's progress. Completed marks the task done.One of: not_started (Not started), in_progress (In progress), completed.
Assign to meassign_to_metrue/false
Assign the task to the account this connection signed in with.
Assign toassign_user_idslist
Microsoft Entra object IDs of the people to assign. They must be members of the plan's group.
Unassignunassign_user_idslist
Microsoft Entra object IDs of assignees to remove.
Add labelsadd_categorieslist
Labels to apply.One or more of: category1 (Label 1), category2 (Label 2), category3 (Label 3), category4 (Label 4), category5 (Label 5), category6 (Label 6), category7 (Label 7), category8 (Label 8), category9 (Label 9), category10 (Label 10), and 15 more.
Remove labelsremove_categorieslist
Labels to take off.One or more of: category1 (Label 1), category2 (Label 2), category3 (Label 3), category4 (Label 4), category5 (Label 5), category6 (Label 6), category7 (Label 7), category8 (Label 8), category9 (Label 9), category10 (Label 10), and 15 more.

Outputs

activeChecklistItemCountnumber
appliedCategoriesobject
assigneePrioritytext
assignee_idslist
assignmentsobject
bucketIdtext
categorieslist
checklistItemCountnumber
completedByobject
completedDateTimetext
conversationThreadIdtext
createdByobject
createdDateTimetext
dueDateTimetext
hasDescriptiontrue/false
idtext
is_completedtrue/false
orderHinttext
percentCompletenumber
planIdtext
previewTypetext
prioritynumber
priority_labeltext
progresstext
referenceCountnumber
startDateTimetext
titletext
Example output
{
  "activeChecklistItemCount": 0,
  "appliedCategories": {
    "category1": true
  },
  "assignee_ids": [
    "6463a5ce-2119-4198-9f2a-628761df4a62"
  ],
  "assignments": {
    "6463a5ce-2119-4198-9f2a-628761df4a62": {
      "assignedBy": {},
      "orderHint": "8585"
    }
  },
  "bucketId": "hsOf2dhOJkqyYYZEtdzDe2QAIUCR",
  "categories": [
    "category1"
  ],
  "checklistItemCount": 0,
  "createdBy": {
    "user": {
      "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
    }
  },
  "createdDateTime": "2026-09-01T10:05:00Z",
  "dueDateTime": "2026-10-01T12:00:00Z",
  "hasDescription": false,
  "id": "01gzSlKkIUSUl6DF_EilrmQAKDhh",
  "is_completed": false,
  "percentComplete": 0,
  "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "previewType": "automatic",
  "priority": 3,
  "priority_label": "important",
  "progress": "not_started",
  "referenceCount": 0,
  "startDateTime": null,
  "title": "Draft the announcement"
}

Update task details

Change a task's description, add checklist items, tick, untick or remove existing ones, and choose what its card shows.

Inputs

Tasktask_idtextRequired
The task's id (use List plan tasks to find one), or a link to the task copied from Planner.
Descriptiondescriptiontext
The task's new description (replaces the old one).
Add checklist itemsadd_checklist_itemslist
Titles of new checklist items to add, unticked.
Tick checklist itemscheck_checklist_item_idslist
Ids of checklist items to tick (from Get task details).
Untick checklist itemsuncheck_checklist_item_idslist
Ids of checklist items to untick (from Get task details).
Remove checklist itemsremove_checklist_item_idslist
Ids of checklist items to delete (from Get task details).
Card previewpreview_typetext
What the task's card shows on the board.One of: automatic, noPreview (No preview), checklist, description, reference (Attachment).

Outputs

checklistobject
checklist_itemslist
descriptiontext
idtext
previewTypetext
referencesobject
Example output
{
  "checklist": {
    "95e27074-6c4a-447a-aa24-9d718a0b86fa": {
      "isChecked": false,
      "orderHint": "85752723",
      "title": "Write the draft"
    }
  },
  "checklist_items": [
    {
      "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa",
      "isChecked": false,
      "title": "Write the draft"
    }
  ],
  "description": "Announce the launch on the blog.",
  "id": "01gzSlKkIUSUl6DF_EilrmQAKDhh",
  "previewType": "checklist",
  "references": {}
}

On this page