Skip to main content

planner task get

Retrieve the specified planner task

Usage​

m365 planner task get [options]

Options​

-i, --id [id]

ID of the task. Specify either id or title but not both. When you specify the task ID, you no longer need to provide the information for bucket, plan, and ownerGroup.

-t, --title [title]

Title of the task. Specify either id or title but not both.

--bucketId [bucketId]

ID of the bucket to which the task belongs. Specify bucketId or bucketName when using title.

--bucketName [bucketName]

Name of the bucket to which the task belongs. Specify bucketId or bucketName when using title.

--planId [planId]

ID of the plan to which the task belongs. Specify either planId, planTitle, or rosterId when using bucketName.

--planTitle [planTitle]

Title of the plan to which the task belongs. Specify either planId, planTitle, or rosterId when using bucketName.

--rosterId [rosterId]

ID of the Planner Roster. Specify either planId, planTitle, or rosterId when using bucketName.

--ownerGroupId [ownerGroupId]

ID of the group to which the plan belongs. Specify ownerGroupId or ownerGroupName when using planTitle.

--ownerGroupName [ownerGroupName]

Name of the group to which the plan belongs. Specify ownerGroupId or ownerGroupName when using planTitle.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, permissions, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Remarks​

warning

When using rosterId, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.

Permissions​

ResourcePermissions
Microsoft GraphTasks.Read, GroupMember.Read.All

Examples​

Returns the Microsoft Planner task by id.

m365 planner task get --id "vzCcZoOv-U27PwydxHB8opcADJo-"

Retrieve the Microsoft Planner task by title from the specified bucket. Based on the specified plan with the title owned by the specified group.

m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"

Returns the Microsoft Planner task by rosterId from the specified bucket.

m365 planner task get --title "New Task" --bucketName "To do" --rosterId "8bc07d47-c06f-41e1-8f00-1c113c8f6067"

Response​

{
  "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
  "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
  "title": "Important task",
  "orderHint": "8585269235419217847",
  "assigneePriority": "",
  "percentComplete": 50,
  "startDateTime": "2023-01-20T00:00:00Z",
  "createdDateTime": "2023-01-25T21:49:03.555796Z",
  "dueDateTime": "2023-02-15T00:00:00Z",
  "hasDescription": true,
  "previewType": "automatic",
  "completedDateTime": null,
  "completedBy": null,
  "referenceCount": 0,
  "checklistItemCount": 2,
  "activeChecklistItemCount": 2,
  "conversationThreadId": null,
  "priority": 5,
  "id": "OopX1ANphEu7Lm4-0tVtl5cAFRGQ",
  "createdBy": {
    "user": {
      "displayName": null,
      "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
    },
    "application": {
      "displayName": null,
      "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
    }
  },
  "appliedCategories": {},
  "assignments": {},
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "references": {},
  "checklist": {
    "4e3c8841-560c-436e-ba06-cc7731680d59": {
      "isChecked": false,
      "title": "Communicate with customer",
      "orderHint": "8585269209601773376",
      "lastModifiedDateTime": "2023-01-25T22:32:05.3002431Z",
      "lastModifiedBy": {
        "user": {
          "displayName": null,
          "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
        }
      }
    }
  }
}