Get teamworkSection

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.

Read the properties of a section in a user's teamwork.

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)	TeamworkSection.Read	TeamworkSection.ReadWrite
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	TeamworkSection.Read.All	TeamworkSection.ReadWrite.All

HTTP request

GET /users/{user-id}/teamwork/sections/{teamworkSection-id}

Optional query parameters

This method supports the $expand OData query parameter to help customize the response. Only the items relationship can be expanded, and only one level of expansion is supported. For more information, see OData query parameters.

When $expand=items is specified, the response includes the items collection inline on the section:

For a user-defined section, the items collection contains the chats, channels, meetings, and communities organized within the section.
For a system-defined section, the items collection is always returned as an empty array ([]). System-defined section contents aren't exposed through the public Graph API.

Request headers

Header	Value
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
If-None-Match	The value of the @microsoft.graph.sectionsVersion annotation returned when you list sections, or the @odata.etag value from any previously retrieved section. If the section hierarchy didn't change, this header returns a `304 Not Modified` response code. Optional.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a teamworkSection object in the response body. If the If-None-Match header is provided and the resource didn't change, this method returns a 304 Not Modified response.

Examples

Example 1: Get a section

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/users/10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f/teamwork/sections/a1b2c3d4-e5f6-7890-abcd-ef1234567890


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://dotnet.territoriali.olinfo.it/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].Teamwork.Sections["{teamworkSection-id}"].GetAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://dotnet.territoriali.olinfo.it/en-us/graph/sdks/create-client?from=snippets&tabs=go
sections, err := graphClient.Users().ByUserId("user-id").Teamwork().Sections().ByTeamworkSectionId("teamworkSection-id").Get(context.Background(), nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

TeamworkSection result = graphClient.users().byUserId("{user-id}").teamwork().sections().byTeamworkSectionId("{teamworkSection-id}").get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let teamworkSection = await client.api('/users/10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f/teamwork/sections/a1b2c3d4-e5f6-7890-abcd-ef1234567890')
	.version('beta')
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->users()->byUserId('user-id')->teamwork()->sections()->byTeamworkSectionId('teamworkSection-id')->get()->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://dotnet.territoriali.olinfo.it/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.users.by_user_id('user-id').teamwork.sections.by_teamwork_section_id('teamworkSection-id').get()

Important

For details about how to add the SDK to your project and create an authProvider instance, see the 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
ETag: "1742515200"

{
  "@odata.type": "#microsoft.graph.teamworkSection",
  "@odata.etag": "\"1742515200\"",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "displayName": "Favorites",
  "displayIcon": {
    "iconType": "⭐",
    "displayName": "Star",
    "contentUrl": null,
    "skinTone": null
  },
  "sectionType": "userDefined",
  "sortType": "mostRecent",
  "isExpanded": true,
  "isHierarchicalViewEnabled": false,
  "createdDateTime": "2025-01-15T10:30:00Z",
  "lastModifiedDateTime": "2025-03-01T14:22:00Z"
}

Example 2: Get a user-defined section with items expanded

The following example uses $expand=items to return the section together with its items collection in a single request.

Request

GET https://graph.microsoft.com/beta/users/10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f/teamwork/sections/a1b2c3d4-e5f6-7890-abcd-ef1234567890?$expand=items

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
ETag: "1742515200"

{
  "@odata.type": "#microsoft.graph.teamworkSection",
  "@odata.etag": "\"1742515200\"",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "displayName": "Favorites",
  "sectionType": "userDefined",
  "sortType": "mostRecent",
  "isExpanded": true,
  "isHierarchicalViewEnabled": false,
  "createdDateTime": "2025-01-15T10:30:00Z",
  "lastModifiedDateTime": "2025-03-01T14:22:00Z",
  "items": [
    {
      "@odata.type": "#microsoft.graph.teamworkSectionItem",
      "id": "19:d5b2c3a4-e6f7-8901-abcd-ef3456789012@thread.v2",
      "itemType": "chat",
      "createdDateTime": "2025-02-10T09:15:00Z",
      "lastModifiedDateTime": "2025-03-05T11:30:00Z"
    },
    {
      "@odata.type": "#microsoft.graph.teamworkSectionItem",
      "id": "19:e6f7a8b9-0123-4567-89ab-cdef01234567@thread.tacv2",
      "itemType": "channel",
      "createdDateTime": "2025-01-20T14:00:00Z",
      "lastModifiedDateTime": "2025-03-01T08:45:00Z"
    }
  ]
}

Example 3: Get a system-defined section with items expanded

The following example uses $expand=items on a system-defined section. The items collection is returned as an empty array because system-defined section contents aren't exposed through the public Graph API.

Request

GET https://graph.microsoft.com/beta/users/10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f/teamwork/sections/b2c3d4e5-f6a7-8901-bcde-f12345678901?$expand=items

Response

HTTP/1.1 200 OK
Content-type: application/json
ETag: "1742515200"

{
  "@odata.type": "#microsoft.graph.teamworkSection",
  "@odata.etag": "\"1742515200\"",
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "displayName": "TeamsAndChannels",
  "sectionType": "systemDefined",
  "sortType": "nameAlphabetical",
  "isExpanded": true,
  "isHierarchicalViewEnabled": true,
  "createdDateTime": "2024-06-10T08:00:00Z",
  "lastModifiedDateTime": "2025-02-28T16:45:00Z",
  "items": []
}

Feedback

Was this page helpful?

Last updated on 2026-05-27

Get teamworkSection

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Examples

Example 1: Get a section

Request

Response

Example 2: Get a user-defined section with items expanded

Request

Response

Example 3: Get a system-defined section with items expanded

Request

Response

Feedback

Additional resources