Skip to content

teamschannelplanner-list-plans.md

Latest commit

 

History

History
150 lines (118 loc) · 5.47 KB

teamschannelplanner-list-plans.md

File metadata and controls

150 lines (118 loc) · 5.47 KB
title List plans
description Get a list of plannerPlan objects owned by a shared channel in Teams.
ms.localizationpriority medium
author DanluCui
ms.subservice planner
doc_type apiPageType
ms.date 01/29/2025

List plans

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a list of plannerPlan objects owned by a shared channel in Teams.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

GET /teams/{team-id}/channels/{channel-id}/planner/plans

Optional query parameters

This method doesn't support OData query parameters to customize the response.

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 plannerPlan objects in the response body.

This method can return any of the HTTP status codes. The most common errors that apps should handle for this method are the 403 and 404 responses. For more information about these errors, see Common Planner error conditions.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/teams/a738af50-90f1-472c-b3c3-a468f88ceaba/channels/19:yVS-hfmJ8w61Vu4oehlAr-y9G0eeyY11D8elrrDSvCU1@thread.tacv2/planner/plans

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

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.etag": "W/\"JzEtUGxhbiAgQEBAQEBAQEBAQEBAQEBARCc=\"",
      "createdDateTime": "2025-01-14T18:03:25.8457422Z",
      "isArchived": false,
      "owner": "ba2b2488-cb8c-4dbc-882e-a9a8311bfee9",
      "title": "travel plan",
      "id": "TQZYwVBC4E6BUIg4nfSnfJUADdBY",
      "createdBy": {
        "application": {
          "id": "de8bc8b5-d9f9-48b1-a8ad-b748da725064"
        },
        "user": {
          "id": "ba2b2488-cb8c-4dbc-882e-a9a8311bfee9"
        }
      },
      "container": {
        "containerId": "a738af50-90f1-472c-b3c3-a468f88ceaba/channels/19:yVS-hfmJ8w61Vu4oehlAr-y9G0eeyY11D8elrrDSvCU1@thread.tacv2",
        "type": "teamsChannel",
        "url": "https://graph.microsoft.com/beta/teams/a738af50-90f1-472c-b3c3-a468f88ceaba/channels/19:yVS-hfmJ8w61Vu4oehlAr-y9G0eeyY11D8elrrDSvCU1@thread.tacv2"
      }
    }
  ]
}