team resource type

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

A team in Microsoft Teams is a collection of channel objects. A channel represents a topic, and therefore a logical isolation of discussion, within a team.

Every team is associated with a group. The group has the same ID as the team - for example, /groups/{id}/team is the same as /teams/{id}. For more information about working with groups and members in teams, see Use the Microsoft Graph REST API to work with Microsoft Teams.

Methods

Method Return Type Description
Create team teamsAsyncOperation Create a team from scratch.
Create team from group team Create a new team, or add a team to an existing group.
Get team team Retrieve the properties and relationships of the specified team.
Update team team Update the properties of the specified team.
Delete team None Delete the team and its associated group.
Clone team teamsAsyncOperation Copy the team and its associated group.
Archive team teamsAsyncOperation Put the team in a read-only state.
Unarchive team teamsAsyncOperation Restore the team to a read-write state.
List your teams team collection List the teams you are a member of.
List all teams group collection List all groups that have teams.
Get team photo Binary data Get the photo (picture) for a team.
Update team photo None Update the photo (picture) for a team.
Publish apps to your organization teamsApp Create Teams apps visible only to your organization.
Add app to team teamsAppInstallation Adds (installs) an app to a team.
Add tab to channel teamsTab Adds (installs) a tab to a team's channel.
List channel messages chatMessage Get messages in a channel
Create chatMessage in a channel chatMessage Send a message to a channel.
Create chatMessage reply in a channel chatMessage Reply to a message in a channel.

Properties

Property Type Description
displayName string The name of the team.
description string An optional description for the team.
classification string An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory.
specialization teamSpecialization Optional. Indicates whether the team is intended for a particular use case. Each team specialization has access to unique behaviors and experiences targeted to its use case.
visibility teamVisibilityType The visibility of a the group and team. Defaults to Public.
funSettings teamFunSettings Settings to configure use of Giphy, memes, and stickers in the team.
guestSettings teamGuestSettings Settings to configure whether guests can create, update, or delete channels in the team.
internalId string A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API.
isArchived Boolean Whether this team is in read-only mode.
memberSettings teamMemberSettings Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team.
messagingSettings teamMessagingSettings Settings to configure messaging and mentions in the team.
discoverySettings teamDiscoverySettings Settings to configure team discoverability by others.
webUrl string (readonly) A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.

Relationships

Relationship Type Description
channels channel collection The collection of channels & messages associated with the team.
installedApps teamsAppInstallation collection The apps installed in this team.
owners user The list of this team's owners. Currently, when creating a team using application permissions, exactly one owner must be specified. When using user delegated permissions, no owner can be specified (the current user is the owner). Owner must be specified as an object ID (GUID), not a UPN.
operations teamsAsyncOperation collection The async operations that ran or are running on this team.
primaryChannel channel The general channel for the team.
schedule schedule The schedule of shifts for this team.
template teamsTemplate The template this team was created from. See available templates.

JSON representation

The following is a JSON representation of the resource.

{
  "guestSettings": {"@odata.type": "microsoft.graph.teamGuestSettings"},
  "memberSettings": {"@odata.type": "microsoft.graph.teamMemberSettings"},
  "messagingSettings": {"@odata.type": "microsoft.graph.teamMessagingSettings"},
  "funSettings": {"@odata.type": "microsoft.graph.teamFunSettings"},
  "discoverySettings": {"@odata.type": "microsoft.graph.teamDiscoverySettings"},
  "internalId": "string",
  "isArchived": false,
  "webUrl": "string (URL)",
  "displayName": "string",
  "description": "string",
  "classification": "string",
  "specialization": "string",
  "visibility": "string"
}

See Also