team resource type

Namespace: microsoft.graph

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.
List members conversationMember collection Get the list of members in the team.
Add member conversationMember Add a new member to the team.
Get member conversationMember collection Get a member in the team.
Update member's role conversationMember Change a member to an owner or back to a regular member.
Remove member None Remove an existing member from the team.
Archive team teamsAsyncOperation Put the team in a read-only state.
Unarchive team teamsAsyncOperation Restore the team to a read-write state.
Clone team teamsAsyncOperation Copy the team and its associated group.
List your teams team collection List the teams you are a member of.
Complete migration team Removes migration mode from the team and makes the team available to users to post and read messages.
List apps installed in team teamsAppInstallation collection List apps installed in a team.
Add app to team None Add (install) an app to a team.
Get app installed in team teamsAppInstallation Get the specified app installed in a team.
Upgrade app installed in team None Upgrade the app installed in a team to the latest version.
Remove app from team None Remove (uninstall) an app from a team.

Properties

Property Type Description
displayName string The name of the team.
description string An optional description for the team. Maximum length: 1024 characters.
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 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.
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.
createdDateTime dateTimeOffset Timestamp at which the team was created.

Instance attributes

Instance attributes are properties with special behaviors. These properties are temporary and either a) define behavior the service should perform or b) provide short-term property values, like a download URL for an item that expires.

Property name Type Description
@microsoft.graph.teamCreationMode string Indicates that the team is in migration state and is currently being used for migration purposes. It accepts one value: migration. Note: In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.

For a POST request example, see Request (create team in migration state).

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.
members conversationMember collection Members and owners of the team.
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.

Note: If the team is of type class, a classSettings property is applied on the team.

{
  "guestSettings": {"@odata.type": "microsoft.graph.teamGuestSettings"},
  "memberSettings": {"@odata.type": "microsoft.graph.teamMemberSettings"},
  "messagingSettings": {"@odata.type": "microsoft.graph.teamMessagingSettings"},
  "funSettings": {"@odata.type": "microsoft.graph.teamFunSettings"},
  "internalId": "string",
  "isArchived": false,
  "webUrl": "string (URL)",
  "classSettings": {"@odata.type": "microsoft.graph.teamClassSettings"},
  "createdDateTime": "dateTimeOffset"
}

See also