ESC
Type to search...

UserTeamwork.Read

Export JSON
Export CSV
Copy URL
Print
Delegated Read User Scope

Allows the app to read the teamwork settings of the signed-in user.

Permission data: April 6, 2026 at 4:06 AM UTC
Delegated Access App-Only Access

Permission Details

Delegated Permission Admin consent required

Read user teamwork settings

Allows the app to read the teamwork settings of the signed-in user.

Properties

Microsoft Graph v1.0 exact-category-docs

Properties is shown from stable Microsoft Graph v1.0 metadata.

Property Type Description
id String The unique identifier for the userTeamwork object.
locale StringNullable Represents the location that a user selected in Microsoft Teams and doesn't follow the Office's locale setting. A user's locale is represented by their preferred language and country or region. For example, en-us. The language component follows two-letter codes as defined in ISO 639-1, and the country component follows two-letter codes as defined in ISO 3166-1 alpha-2.
region stringNullable Represents the region of the organization or the user. For users with multigeo licenses, the property contains the user's region (if available). For users without multigeo licenses, the property contains the organization's region., , The region value can be any region supported by the Teams payload. The possible values are: Americas, Europe and MiddleEast, Asia Pacific, UAE, Australia, Brazil, Canada, Switzerland, Germany, France, India, Japan, South Korea, Norway, Singapore, United Kingdom, South Africa, Sweden, Qatar, Poland, Italy, Israel, Spain, Mexico, USGov Community Cloud, USGov Community Cloud High, USGov Department of Defense, and China.
associatedTeams associatedTeamInfo collection The list of associatedTeamInfo objects that a user is associated with.
installedApps userScopeTeamsAppInstallation collection The apps installed in the personal scope of this user.

JSON Representation

Microsoft Graph v1.0 exact-category-docs

JSON representation is shown from stable Microsoft Graph v1.0 metadata.

JSON representation
{
  "id": "String (identifier)",
  "locale": "String",
  "region": "String"
}

Relationships

Microsoft Graph v1.0 exact-category-docs

Relationships is shown from stable Microsoft Graph v1.0 metadata.

Relationship Type Description
associatedTeams associatedTeamInfo collection The list of associatedTeamInfo objects that a user is associated with.
installedApps teamsAppInstallation collection The apps installed in the personal scope of this user.

Graph Methods

Delegated access App-only access
Exact Microsoft Learn match

Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET /users/{user-id}/teamwork
Exact Microsoft Learn match

Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET /users/{user-id}/teamwork
Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
Get-MgUserTeamwork /users/{user-id}/teamwork
Get userTeamwork
Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
Get-MgBetaUserTeamwork /users/{user-id}/teamwork
Get userTeamwork

Code Examples

C# / .NET SDK
Get userTeamwork
// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].Teamwork.GetAsync();
JavaScript
Get userTeamwork
const options = {
	authProvider,
};

const client = Client.init(options);

let userTeamwork = await client.api('/users/2f39ffba-51ca-4d2d-a66f-a020a83ce208/teamwork')
	.get();
PowerShell
Get userTeamwork
Import-Module Microsoft.Graph.Teams

Get-MgUserTeamwork -UserId $userId
Python
Get userTeamwork
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

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

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Delegated permissions and search for UserTeamwork.Read

4

Grant Admin Consent

This delegated permission requires admin consent.