Microsoft Graph Planner is the set of Microsoft Graph APIs that lets developers programmatically work with Microsoft Planner data across Microsoft 365. With it, you can create and manage plans, buckets, and tasks; assign tasks to people; set due dates, priority, progress, labels, checklists, and attachments; and move tasks across boards to reflect workflow.
openapi: 3.1.0
info:
title: Microsoft Graph Planner
description: Needs a description.
paths:
/groups/{group-id}/planner:
description: >-
Provides operations to manage the planner property of the
microsoft.graph.group entity.
get:
tags:
- groups.plannerGroup
summary: Microsoft Graph Get planner from groups
description: Entry-point to Planner resource that might exist for a Unified Group.
operationId: groups.GetPlanner
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.plannerGroup
summary: Microsoft Graph Update the navigation property planner in groups
operationId: groups.UpdatePlanner
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerGroup'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.plannerGroup
summary: Microsoft Graph Delete navigation property planner for groups
operationId: groups.DeletePlanner
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
/groups/{group-id}/planner/plans:
description: >-
Provides operations to manage the plans property of the
microsoft.graph.plannerGroup entity.
get:
tags:
- groups.plannerGroup
summary: Microsoft Graph List plans
description: Retrieve a list of plannerPlan objects owned by a group object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/plannergroup-list-plans?view=graph-rest-1.0
operationId: groups.planner.ListPlans
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.plannerPlanCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- groups.plannerGroup
summary: Microsoft Graph Create new navigation property to plans for groups
operationId: groups.planner.CreatePlans
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
/groups/{group-id}/planner/plans/{plannerPlan-id}:
description: >-
Provides operations to manage the plans property of the
microsoft.graph.plannerGroup entity.
get:
tags:
- groups.plannerGroup
summary: Microsoft Graph Get plans from groups
description: Read-only. Nullable. Returns the plannerPlans owned by the group.
operationId: groups.planner.GetPlans
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.plannerGroup
summary: Microsoft Graph Update the navigation property plans in groups
operationId: groups.planner.UpdatePlans
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.plannerGroup
summary: Microsoft Graph Delete navigation property plans for groups
operationId: groups.planner.DeletePlans
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets:
description: >-
Provides operations to manage the buckets property of the
microsoft.graph.plannerPlan entity.
get:
tags:
- groups.plannerGroup
summary: Microsoft Graph Get buckets from groups
description: Read-only. Nullable. Collection of buckets in the plan.
operationId: groups.planner.plans.ListBuckets
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.plannerBucketCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- groups.plannerGroup
summary: Microsoft Graph Create new navigation property to buckets for groups
operationId: groups.planner.plans.CreateBuckets
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}:
description: >-
Provides operations to manage the buckets property of the
microsoft.graph.plannerPlan entity.
get:
tags:
- groups.plannerGroup
summary: Microsoft Graph Get buckets from groups
description: Read-only. Nullable. Collection of buckets in the plan.
operationId: groups.planner.plans.GetBuckets
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.plannerGroup
summary: Microsoft Graph Update the navigation property buckets in groups
operationId: groups.planner.plans.UpdateBuckets
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.plannerGroup
summary: Microsoft Graph Delete navigation property buckets for groups
operationId: groups.planner.plans.DeleteBuckets
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks:
description: >-
Provides operations to manage the tasks property of the
microsoft.graph.plannerBucket entity.
get:
tags:
- groups.plannerGroup
summary: Microsoft Graph Get tasks from groups
description: Read-only. Nullable. The collection of tasks in the bucket.
operationId: groups.planner.plans.buckets.ListTasks
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.plannerTaskCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- groups.plannerGroup
summary: Microsoft Graph Create new navigation property to tasks for groups
operationId: groups.planner.plans.buckets.CreateTasks
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}:
description: >-
Provides operations to manage the tasks property of the
microsoft.graph.plannerBucket entity.
get:
tags:
- groups.plannerGroup
summary: Microsoft Graph Get tasks from groups
description: Read-only. Nullable. The collection of tasks in the bucket.
operationId: groups.planner.plans.buckets.GetTasks
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.plannerGroup
summary: Microsoft Graph Update the navigation property tasks in groups
operationId: groups.planner.plans.buckets.UpdateTasks
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.plannerGroup
summary: Microsoft Graph Delete navigation property tasks for groups
operationId: groups.planner.plans.buckets.DeleteTasks
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
? /groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat
: description: >-
Provides operations to manage the assignedToTaskBoardFormat property of
the microsoft.graph.plannerTask entity.
get:
tags:
- groups.plannerGroup
summary: Microsoft Graph Get assignedToTaskBoardFormat from groups
description: >-
Read-only. Nullable. Used to render the task correctly in the task board
view when grouped by assignedTo.
operationId: groups.planner.plans.buckets.tasks.GetAssignedToTaskBoardFormat
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.plannerGroup
summary: Microsoft Graph Update the navigation property assignedToTaskBoardFormat in groups
operationId: groups.planner.plans.buckets.tasks.UpdateAssignedToTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.plannerGroup
summary: Microsoft Graph Delete navigation property assignedToTaskBoardFormat for groups
operationId: groups.planner.plans.buckets.tasks.DeleteAssignedToTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat
/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat:
description: >-
Provides operations to manage the bucketTaskBoardFormat property of the
microsoft.graph.plannerTask entity.
get:
tags:
- groups.plannerGroup
summary: Microsoft Graph Get bucketTaskBoardFormat from groups
description: >-
Read-only. Nullable. Used to render the task correctly in the task board
view when grouped by bucket.
operationId: groups.planner.plans.buckets.tasks.GetBucketTaskBoardFormat
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.plannerGroup
summary: Microsoft Graph Update the navigation property bucketTaskBoardFormat in groups
operationId: groups.planner.plans.buckets.tasks.UpdateBucketTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.plannerGroup
summary: Microsoft Graph Delete navigation property bucketTaskBoardFormat for groups
operationId: groups.planner.plans.buckets.tasks.DeleteBucketTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/groups/{group-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat
/groups/{group-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details:
description: >-
Provides operations to manage the details property of the
microsoft.graph.plannerTask entity.
get:
tags:
- groups.plannerGroup
summary: Microsoft Graph Get details from groups
description: Read-only. Nullable. More details about the task.
operationId: groups.planner.plans.buckets.tasks.GetDetails
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.plannerGroup
summary: Microsoft Graph Update the navigation property details in groups
operationId: groups.planner.plans.buckets.tasks.UpdateDetails
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.
# --- truncated at 32 KB (372 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/planner-openapi-original.yml