Microsoft Planner

Microsoft Planner is a task management tool that helps teams organize work, assign tasks, share files, and collaborate on projects within Microsoft 365.

6 APIs 10 Features

CollaborationMicrosoft 365ProductivityProject ManagementTask Management

APIs

Microsoft Planner API

RESTful API for accessing and managing tasks, plans, and buckets in Microsoft Planner through Microsoft Graph.

Microsoft Graph Plans API

API for creating, reading, updating, and deleting plans in Microsoft Planner through Microsoft Graph. Plans are the containers for tasks and are owned by groups or other contain...

Microsoft Graph Tasks API

API for creating, reading, updating, and deleting tasks in Microsoft Planner through Microsoft Graph. Tasks are contained in plans and can be assigned to buckets and users.

Microsoft Graph Buckets API

API for creating, reading, updating, and deleting buckets in Microsoft Planner through Microsoft Graph. Buckets represent custom columns for organizing tasks within a plan.

Microsoft Graph Planner API (Beta)

Beta version of the Planner API in Microsoft Graph providing access to preview features including plannerRoster resources, business scenarios integration, and expanded container...

Microsoft Graph Business Scenarios Planner API (Beta)

Beta API for integrating external business processes with Microsoft Planner through business scenarios, allowing creation of scenario-controlled Planner tasks and plans.

Collections

Microsoft Planner Microsoft Graph Planner API

POSTMAN

Microsoft Planner Microsoft Graph Planner API

OPEN

Arazzo Workflows

Microsoft Planner Add a Bucket and Task to an Existing Plan

Confirm a plan exists, create a new bucket in it, then add a task to that bucket.

ARAZZO

Microsoft Planner Complete My First Assigned Task

List tasks assigned to the signed-in user and, if any exist, mark the first one complete.

ARAZZO

Microsoft Planner Mark a Task Complete

Read a task to capture its ETag, then patch it to 100 percent complete.

ARAZZO

Microsoft Planner Stand Up a Plan with a Bucket and First Task

Create a plan in a group, add a bucket to it, then create the first task in that bucket.

ARAZZO

Microsoft Planner Create a Task and Populate Its Details

Create a task in a plan, then read and update its task details with a description and checklist.

ARAZZO

Microsoft Planner Drill From Group to Plan to Tasks

List a group's plans, pick the first plan, and list that plan's tasks and buckets.

ARAZZO

Microsoft Planner Move a Task Into a Different Bucket

Confirm the target bucket exists, read the task ETag, then reassign the task to that bucket.

ARAZZO

Microsoft Planner Rename a Plan and Describe Its Categories

Read a plan and its details for ETags, rename the plan, then set category label descriptions.

ARAZZO

Pricing Plans

Microsoft Planner Plans Pricing

4 plans

PLANS

Rate Limits

Microsoft Planner Rate Limits

4 limits

RATE LIMITS

FinOps

Microsoft Planner Finops

FINOPS

Features

Visual task boards with drag-and-drop organization

Plan creation tied to Microsoft 365 Groups

Task assignment with due dates and priorities

Bucket-based task categorization and organization

Checklist subtasks within individual tasks

File attachment and external reference linking

Progress tracking with charts and status views

Microsoft Teams integration for collaborative planning

Category labels for cross-cutting task classification

Microsoft Graph API for programmatic access

Use Cases

Project management for team-based work coordination

Sprint planning and agile task tracking

Onboarding workflows for new employees

Event planning with task delegation and deadlines

Content publishing calendars and editorial workflows

IT helpdesk ticket organization and tracking

Marketing campaign task management

Cross-functional team collaboration on initiatives

Integrations

Microsoft Teams for in-chat task management

Microsoft To Do for personal task sync

Power Automate for workflow automation

SharePoint for document-linked tasks

Outlook for email-to-task conversion

Excel for data export and reporting

Power BI for advanced analytics dashboards

Azure DevOps for development task bridging

Semantic Vocabularies

Microsoft Planner Context

0 classes · 0 properties

JSON-LD

API Governance Rules

Microsoft Planner API Rules

7 rules · 7 errors

SPECTRAL

JSON Structure

Microsoft Planner Identity Set Structure

0 properties

JSON STRUCTURE

Microsoft Planner Identity Structure

2 properties

JSON STRUCTURE

Microsoft Planner O Data Error Structure

1 properties

JSON STRUCTURE

Microsoft Planner Planner Applied Categories Structure

0 properties

JSON STRUCTURE

Microsoft Planner Planner Assignment Structure

3 properties

JSON STRUCTURE

Microsoft Planner Planner Assignments Structure

0 properties

JSON STRUCTURE

Microsoft Planner Planner Bucket Collection Structure

3 properties

JSON STRUCTURE

Microsoft Planner Planner Bucket Create Structure

3 properties

JSON STRUCTURE

Microsoft Planner Planner Bucket Structure

5 properties

JSON STRUCTURE

Microsoft Planner Planner Bucket Update Structure

2 properties

JSON STRUCTURE

Microsoft Planner Planner Category Descriptions Structure

25 properties

JSON STRUCTURE

Microsoft Planner Planner Checklist Item Structure

5 properties

JSON STRUCTURE

Microsoft Planner Planner Checklist Items Structure

0 properties

JSON STRUCTURE

Microsoft Planner Planner External Reference Structure

5 properties

JSON STRUCTURE

Microsoft Planner Planner External References Structure

0 properties

JSON STRUCTURE

Microsoft Planner Planner Plan Collection Structure

3 properties

JSON STRUCTURE

Microsoft Planner Planner Plan Container Structure

3 properties

JSON STRUCTURE

Microsoft Planner Planner Plan Create Structure

2 properties

JSON STRUCTURE

Microsoft Planner Planner Plan Details Structure

2 properties

JSON STRUCTURE

Microsoft Planner Planner Plan Details Update Structure

0 properties

JSON STRUCTURE

Microsoft Planner Planner Plan Structure

5 properties

JSON STRUCTURE

Microsoft Planner Planner Plan Update Structure

1 properties

JSON STRUCTURE

Microsoft Planner Planner Task Collection Structure

3 properties

JSON STRUCTURE

Microsoft Planner Planner Task Create Structure

10 properties

JSON STRUCTURE

Microsoft Planner Planner Task Details Structure

4 properties

JSON STRUCTURE

Microsoft Planner Planner Task Details Update Structure

2 properties

JSON STRUCTURE

Microsoft Planner Planner Task Structure

19 properties

JSON STRUCTURE

Microsoft Planner Planner Task Update Structure

10 properties

JSON STRUCTURE

Microsoft Planner Planner User Ids Structure

0 properties

JSON STRUCTURE

Microsoft Planner Structure

0 properties

JSON STRUCTURE

Example Payloads

Microsoft Planner Createbucket Example

6 fields

EXAMPLE

Microsoft Planner Createplan Example

6 fields

EXAMPLE

Microsoft Planner Createtask Example

6 fields

EXAMPLE

Microsoft Planner Getbucket Example

6 fields

EXAMPLE

Microsoft Planner Getplan Example

6 fields

EXAMPLE

Microsoft Planner Getplandetails Example

6 fields

EXAMPLE

Microsoft Planner Gettask Example

6 fields

EXAMPLE

Microsoft Planner Gettaskdetails Example

6 fields

EXAMPLE

Microsoft Planner Identity Example

2 fields

EXAMPLE

Microsoft Planner Identity Set Example

EXAMPLE

Microsoft Planner Listbuckettasks Example

6 fields

EXAMPLE

Microsoft Planner Listgroupplans Example

6 fields

EXAMPLE

Microsoft Planner Listmytasks Example

6 fields

EXAMPLE

Microsoft Planner Listplanbuckets Example

6 fields

EXAMPLE

Microsoft Planner Listplantasks Example

6 fields

EXAMPLE

Microsoft Planner Listusertasks Example

6 fields

EXAMPLE

Microsoft Planner O Data Error Example

1 fields

EXAMPLE

Microsoft Planner Planner Applied Categories Example

EXAMPLE

Microsoft Planner Planner Assignment Example

3 fields

EXAMPLE

Microsoft Planner Planner Assignments Example

EXAMPLE

Microsoft Planner Planner Bucket Collection Example

3 fields

EXAMPLE

Microsoft Planner Planner Bucket Create Example

3 fields

EXAMPLE

Microsoft Planner Planner Bucket Example

5 fields

EXAMPLE

Microsoft Planner Planner Bucket Update Example

2 fields

EXAMPLE

Microsoft Planner Planner Category Descriptions Example

25 fields

EXAMPLE

Microsoft Planner Planner Checklist Item Example

5 fields

EXAMPLE

Microsoft Planner Planner Checklist Items Example

EXAMPLE

Microsoft Planner Planner External Reference Example

5 fields

EXAMPLE

Microsoft Planner Planner External References Example

EXAMPLE

Microsoft Planner Planner Plan Collection Example

3 fields

EXAMPLE

Microsoft Planner Planner Plan Container Example

3 fields

EXAMPLE

Microsoft Planner Planner Plan Create Example

2 fields

EXAMPLE

Microsoft Planner Planner Plan Details Example

2 fields

EXAMPLE

Microsoft Planner Planner Plan Details Update Example

EXAMPLE

Microsoft Planner Planner Plan Example

5 fields

EXAMPLE

Microsoft Planner Planner Plan Update Example

1 fields

EXAMPLE

Microsoft Planner Planner Task Collection Example

3 fields

EXAMPLE

Microsoft Planner Planner Task Create Example

10 fields

EXAMPLE

Microsoft Planner Planner Task Details Example

4 fields

EXAMPLE

Microsoft Planner Planner Task Details Update Example

2 fields

EXAMPLE

Microsoft Planner Planner Task Example

19 fields

EXAMPLE

Microsoft Planner Planner Task Update Example

10 fields

EXAMPLE

Microsoft Planner Planner User Ids Example

EXAMPLE

Microsoft Planner Updatebucket Example

6 fields

EXAMPLE

Microsoft Planner Updateplan Example

6 fields

EXAMPLE

Microsoft Planner Updateplandetails Example

6 fields

EXAMPLE

Microsoft Planner Updatetask Example

6 fields

EXAMPLE

Microsoft Planner Updatetaskdetails Example

6 fields

EXAMPLE

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Microsoft Planner Microsoft Graph Planner API
  version: 1.0.0
request:
  auth:
    type: oauth2
    flow: authorization_code
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
    accessTokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Plans
    type: folder
  items:
  - info:
      name: Microsoft Planner Create a Plan
      type: http
    http:
      method: POST
      url: https://graph.microsoft.com/v1.0/planner/plans
      body:
        type: json
        data: '{}'
    docs: Create a new plannerPlan object. The plan is contained within a Microsoft 365 group specified by the container property.
  - info:
      name: Microsoft Planner Get a Plan
      type: http
    http:
      method: GET
      url: https://graph.microsoft.com/v1.0/planner/plans/:plan-id
      params:
      - name: plan-id
        value: ''
        type: path
        description: The unique identifier of the plannerPlan (28 characters, case-sensitive)
    docs: Retrieve the properties and relationships of a plannerPlan object.
  - info:
      name: Microsoft Planner Update a Plan
      type: http
    http:
      method: PATCH
      url: https://graph.microsoft.com/v1.0/planner/plans/:plan-id
      headers:
      - name: If-Match
        value: ''
      params:
      - name: plan-id
        value: ''
        type: path
        description: The unique identifier of the plannerPlan (28 characters, case-sensitive)
      body:
        type: json
        data: '{}'
    docs: Update the properties of a plannerPlan object. Requires the If-Match header with the last known ETag value of the
      plan.
  - info:
      name: Microsoft Planner Delete a Plan
      type: http
    http:
      method: DELETE
      url: https://graph.microsoft.com/v1.0/planner/plans/:plan-id
      headers:
      - name: If-Match
        value: ''
      params:
      - name: plan-id
        value: ''
        type: path
        description: The unique identifier of the plannerPlan (28 characters, case-sensitive)
    docs: Delete a plannerPlan object. Requires the If-Match header with the last known ETag value of the plan.
  - info:
      name: Microsoft Planner List Plan Tasks
      type: http
    http:
      method: GET
      url: https://graph.microsoft.com/v1.0/planner/plans/:plan-id/tasks
      params:
      - name: plan-id
        value: ''
        type: path
        description: The unique identifier of the plannerPlan (28 characters, case-sensitive)
    docs: Retrieve a list of plannerTask objects associated with a plannerPlan object.
  - info:
      name: Microsoft Planner List Group Plans
      type: http
    http:
      method: GET
      url: https://graph.microsoft.com/v1.0/groups/:group-id/planner/plans
      params:
      - name: group-id
        value: ''
        type: path
        description: The unique identifier of the Microsoft 365 group
    docs: Retrieve a list of plannerPlan objects owned by a Microsoft 365 group.
- info:
    name: Buckets
    type: folder
  items:
  - info:
      name: Microsoft Planner List Plan Buckets
      type: http
    http:
      method: GET
      url: https://graph.microsoft.com/v1.0/planner/plans/:plan-id/buckets
      params:
      - name: plan-id
        value: ''
        type: path
        description: The unique identifier of the plannerPlan (28 characters, case-sensitive)
    docs: Retrieve a list of plannerBucket objects contained in a plannerPlan object.
  - info:
      name: Microsoft Planner Create a Bucket
      type: http
    http:
      method: POST
      url: https://graph.microsoft.com/v1.0/planner/buckets
      body:
        type: json
        data: '{}'
    docs: Create a new plannerBucket object. The bucket must specify a planId indicating which plan it belongs to.
  - info:
      name: Microsoft Planner Get a Bucket
      type: http
    http:
      method: GET
      url: https://graph.microsoft.com/v1.0/planner/buckets/:bucket-id
      params:
      - name: bucket-id
        value: ''
        type: path
        description: The unique identifier of the plannerBucket (28 characters, case-sensitive)
    docs: Retrieve the properties and relationships of a plannerBucket object.
  - info:
      name: Microsoft Planner Update a Bucket
      type: http
    http:
      method: PATCH
      url: https://graph.microsoft.com/v1.0/planner/buckets/:bucket-id
      headers:
      - name: If-Match
        value: ''
      params:
      - name: bucket-id
        value: ''
        type: path
        description: The unique identifier of the plannerBucket (28 characters, case-sensitive)
      body:
        type: json
        data: '{}'
    docs: Update the properties of a plannerBucket object. Requires the If-Match header with the last known ETag value of
      the bucket.
  - info:
      name: Microsoft Planner Delete a Bucket
      type: http
    http:
      method: DELETE
      url: https://graph.microsoft.com/v1.0/planner/buckets/:bucket-id
      headers:
      - name: If-Match
        value: ''
      params:
      - name: bucket-id
        value: ''
        type: path
        description: The unique identifier of the plannerBucket (28 characters, case-sensitive)
    docs: Delete a plannerBucket object. Requires the If-Match header with the last known ETag value of the bucket.
  - info:
      name: Microsoft Planner List Bucket Tasks
      type: http
    http:
      method: GET
      url: https://graph.microsoft.com/v1.0/planner/buckets/:bucket-id/tasks
      params:
      - name: bucket-id
        value: ''
        type: path
        description: The unique identifier of the plannerBucket (28 characters, case-sensitive)
    docs: Retrieve a list of plannerTask objects associated with a plannerBucket object.
- info:
    name: Plan Details
    type: folder
  items:
  - info:
      name: Microsoft Planner Get Plan Details
      type: http
    http:
      method: GET
      url: https://graph.microsoft.com/v1.0/planner/plans/:plan-id/details
      params:
      - name: plan-id
        value: ''
        type: path
        description: The unique identifier of the plannerPlan (28 characters, case-sensitive)
    docs: Retrieve the properties and relationships of a plannerPlanDetails object.
  - info:
      name: Microsoft Planner Update Plan Details
      type: http
    http:
      method: PATCH
      url: https://graph.microsoft.com/v1.0/planner/plans/:plan-id/details
      headers:
      - name: If-Match
        value: ''
      params:
      - name: plan-id
        value: ''
        type: path
        description: The unique identifier of the plannerPlan (28 characters, case-sensitive)
      body:
        type: json
        data: '{}'
    docs: Update the properties of a plannerPlanDetails object. Requires the If-Match header with the last known ETag value.
- info:
    name: Tasks
    type: folder
  items:
  - info:
      name: Microsoft Planner Create a Task
      type: http
    http:
      method: POST
      url: https://graph.microsoft.com/v1.0/planner/tasks
      body:
        type: json
        data: '{}'
    docs: Create a new plannerTask. The task must specify a planId to indicate which plan it belongs to. Tasks cannot be created
      without plans.
  - info:
      name: Microsoft Planner Get a Task
      type: http
    http:
      method: GET
      url: https://graph.microsoft.com/v1.0/planner/tasks/:task-id
      params:
      - name: task-id
        value: ''
        type: path
        description: The unique identifier of the plannerTask (28 characters, case-sensitive)
    docs: Retrieve the properties and relationships of a plannerTask object.
  - info:
      name: Microsoft Planner Update a Task
      type: http
    http:
      method: PATCH
      url: https://graph.microsoft.com/v1.0/planner/tasks/:task-id
      headers:
      - name: If-Match
        value: ''
      params:
      - name: task-id
        value: ''
        type: path
        description: The unique identifier of the plannerTask (28 characters, case-sensitive)
      body:
        type: json
        data: '{}'
    docs: Update the properties of a plannerTask object. Requires the If-Match header with the last known ETag value of the
      task.
  - info:
      name: Microsoft Planner Delete a Task
      type: http
    http:
      method: DELETE
      url: https://graph.microsoft.com/v1.0/planner/tasks/:task-id
      headers:
      - name: If-Match
        value: ''
      params:
      - name: task-id
        value: ''
        type: path
        description: The unique identifier of the plannerTask (28 characters, case-sensitive)
    docs: Delete a plannerTask object. Requires the If-Match header with the last known ETag value of the task.
  - info:
      name: Microsoft Planner List My Tasks
      type: http
    http:
      method: GET
      url: https://graph.microsoft.com/v1.0/me/planner/tasks
    docs: Retrieve a list of plannerTask objects assigned to the signed-in user.
  - info:
      name: Microsoft Planner List User Tasks
      type: http
    http:
      method: GET
      url: https://graph.microsoft.com/v1.0/users/:user-id/planner/tasks
      params:
      - name: user-id
        value: ''
        type: path
        description: The unique identifier of the user
    docs: Retrieve a list of plannerTask objects assigned to a specific user.
- info:
    name: Task Details
    type: folder
  items:
  - info:
      name: Microsoft Planner Get Task Details
      type: http
    http:
      method: GET
      url: https://graph.microsoft.com/v1.0/planner/tasks/:task-id/details
      params:
      - name: task-id
        value: ''
        type: path
        description: The unique identifier of the plannerTask (28 characters, case-sensitive)
    docs: Retrieve the properties and relationships of a plannerTaskDetails object.
  - info:
      name: Microsoft Planner Update Task Details
      type: http
    http:
      method: PATCH
      url: https://graph.microsoft.com/v1.0/planner/tasks/:task-id/details
      headers:
      - name: If-Match
        value: ''
      params:
      - name: task-id
        value: ''
        type: path
        description: The unique identifier of the plannerTask (28 characters, case-sensitive)
      body:
        type: json
        data: '{}'
    docs: Update the properties of a plannerTaskDetails object. Requires the If-Match header with the last known ETag value.
bundled: true