plannerPlan resource type


APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

The plannerPlan resource represents a plan in Office 365. A plan can be owned by a group and contains a collection of plannerTasks. It can also have a collection of plannerBuckets. Each plan object has a details object which can contain more information about the plan. For more information about the relationships between groups, plans, and tasks, see Planner.


Method Return Type Description
Get plannerPlan plannerPlan Read properties and relationships of plannerPlan object.
List buckets plannerBucket collection Get a plannerBucket object collection.
List tasks plannerTask collection Get a plannerTask object collection.
Update plannerPlan Update plannerPlan object.


Property Type Description
createdDateTime DateTimeOffset Read-only. Date and time at which the plan is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
id String Read-only. ID of the plan. It is 28 characters long and case-sensitive. Format validation is done on the service.
owner String ID of the Group that owns the plan. A valid group must exist before this field can be set. After it is set, this property can’t be updated.
title String Required. Title of the plan.
createdBy identitySet Read-only. The user who created the plan.
contexts plannerPlanContextCollection Read-only. Additional user experiences in which this plan is used, represented as plannerPlanContext entries.


Relationship Type Description
buckets plannerBucket collection Read-only. Nullable. Collection of buckets in the plan.
details plannerPlanDetails Read-only. Nullable. Additional details about the plan.
tasks plannerTask collection Read-only. Nullable. Collection of tasks in the plan.

JSON representation

Here is a JSON representation of the resource.

  "contexts": {
    "48#19%3Ad128c63941b24733951ea7defd81e550%40thread%2Eskype19%3Ad128c63941b24733951ea7defd81e550%40thread%2Eskype": {
        "@odata.type": "#microsoft.graph.plannerPlanContext",
        "associationType": "Board",
        "createdDateTime": "2015-10-14T00:57:28.4698344Z",
        "displayNameSegments": [
            "Finance Team",
            "Budget Plans"
        "ownerAppId": "5e3ce6c0-2b1f-4285-8d4b-75ee78787346"
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "owner": "String",
  "title": "String"