Edit

List plans_v2

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get a list of the plan objects and their properties.

API availability

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ❌ ❌ ❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Tasks.Read Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Tasks.Read.All Not available.

HTTP request

GET /planner/plans_v2?$filter=container/containerType eq '{container-type}' and container/containerId eq '{container-id}'

The $filter query parameter is required. Specify both container/containerType and container/containerId, combined with and, to identify the owning container. This endpoint isn't an unfiltered list of every plan.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of plan objects in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/planner/plans_v2?$filter=container/containerType eq 'group' and container/containerId eq '5d5a917d-aef4-4fdc-bc99-6048a39aa329'

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.plan",
      "id": "da037802-c736-af41-ff32-789862c95bd9",
      "displayName": "Product launch",
      "container": {
        "containerId": "5d5a917d-aef4-4fdc-bc99-6048a39aa329",
        "containerType": "group"
      }
    }
  ]
}