List teams

Article
08/04/2022
10 minutes to read

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.

List all teams in an organization.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Team.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	Team.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All

HTTP request

GET /teams

Optional query parameters

This method supports the $filter, $select, $top, $skiptoken, and $count OData query parameters to help customize the response.

Request headers

Header	Value
Authorization	Bearer {token}. Required.
Accept	application/json

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and collection of team objects in the response body.

Note

Currently, this API call returns only the id, displayName, and description properties of a team. To get all properties, use the Get team operation.

Examples

Example 1: Get a list of teams

Request

The following is an example of the request.

GET https://graph.microsoft.com/beta/teams


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var teams = await graphClient.Teams
	.Request()
	.Filter("displayName eq 'A Contoso Team'")
	.Select("id,description")
	.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.


const options = {
	authProvider,
};

const client = Client.init(options);

let teams = await client.api('/teams')
	.version('beta')
	.filter('displayName eq \'A Contoso Team\'')
	.select('id,description')
	.get();

Important

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


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

TeamCollectionPage teams = graphClient.teams()
	.buildRequest()
	.filter("displayName eq 'A Contoso Team'")
	.select("id,description")
	.get();

Important

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


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestParameters := &graphconfig.TeamsRequestBuilderGetQueryParameters{
	Filter: "displayName eq 'A Contoso Team'",
	Select: [] string {"id","description"},
}
configuration := &graphconfig.TeamsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

result, err := graphClient.Teams().GetWithRequestConfigurationAndResponseHandler(configuration, nil)

Important

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


Import-Module Microsoft.Graph.Teams

Get-MgTeam -Filter "displayName eq 'A Contoso Team'" -Property "id,description"  -OutFile $outFileId

Important

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


<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestConfiguration = new TeamsRequestBuilderGetRequestConfiguration();

$queryParameters = new TeamsRequestBuilderGetQueryParameters();
$queryParameters->filter = "displayName eq 'A Contoso Team'";
$queryParameters->select = ["id","description"];

$requestConfiguration->queryParameters = $queryParameters;


$requestResult = $graphServiceClient->teams()->get($requestConfiguration);

Important

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

Response

The following is an example of a response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "id": "172b0cce-e65d-44ce-9a49-91d9f2e8493a",
      "displayName": "Contoso Team",
      "description": "This is a Contoso team, used to showcase the range of properties supported by this API"
    },
    {
      "id": "890972b0cce-e65d-44ce-9a49-568hhsd7n",
      "displayName": "Contoso General Team",
      "description": "This is a general Contoso team"
    },
    {
      "id": "98678abcce0-e65d-44ce-9a49-9980bj8kl0e",
      "displayName": "Contoso API Team",
      "description": "This is Contoso API team"
    }
  ]
}

Example 2: Use $filter and $top to get two teams with a display name that starts with 'A'

Request

The following is an example of the request.

GET https://graph.microsoft.com/beta/teams?$filter=startswith(displayName, 'A')&$top=2


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var teams = await graphClient.Teams
	.Request()
	.Filter("displayName eq 'A Contoso Team'")
	.Select("id,description")
	.GetAsync();

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 teams = await client.api('/teams')
	.version('beta')
	.filter('displayName eq \'A Contoso Team\'')
	.select('id,description')
	.get();

Important

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


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

TeamCollectionPage teams = graphClient.teams()
	.buildRequest()
	.filter("displayName eq 'A Contoso Team'")
	.select("id,description")
	.get();

Important

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


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestParameters := &graphconfig.TeamsRequestBuilderGetQueryParameters{
	Filter: "displayName eq 'A Contoso Team'",
	Select: [] string {"id","description"},
}
configuration := &graphconfig.TeamsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

result, err := graphClient.Teams().GetWithRequestConfigurationAndResponseHandler(configuration, nil)

Important

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


Import-Module Microsoft.Graph.Teams

Get-MgTeam -Filter "displayName eq 'A Contoso Team'" -Property "id,description"  -OutFile $outFileId

Important

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


<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestConfiguration = new TeamsRequestBuilderGetRequestConfiguration();

$queryParameters = new TeamsRequestBuilderGetQueryParameters();
$queryParameters->filter = "displayName eq 'A Contoso Team'";
$queryParameters->select = ["id","description"];

$requestConfiguration->queryParameters = $queryParameters;


$requestResult = $graphServiceClient->teams()->get($requestConfiguration);

Important

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

Response

The following is an example of a response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "id": "172b0cce-e65d-44ce-9a49-91d9f2e8493a",
      "displayName": "A Contoso Team",
      "description": "This is a Contoso team, used to showcase the range of properties supported by this API"
    },
    {
      "id": "890972b0cce-e65d-44ce-9a49-568hhsd7n",
      "displayName": "A Contoso Notification Team",
      "description": "This is a notification Contoso team"
    }
  ]
}

Example 3: Use $filter and $select to get id and description for team with displayName equals "A Contoso Team"

Request

The following is an example of the request.

GET https://graph.microsoft.com/beta/teams?$filter=displayName eq 'A Contoso Team'&$select=id,description


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var teams = await graphClient.Teams
	.Request()
	.Filter("displayName eq 'A Contoso Team'")
	.Select("id,description")
	.GetAsync();

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 teams = await client.api('/teams')
	.version('beta')
	.filter('displayName eq \'A Contoso Team\'')
	.select('id,description')
	.get();

Important

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


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

TeamCollectionPage teams = graphClient.teams()
	.buildRequest()
	.filter("displayName eq 'A Contoso Team'")
	.select("id,description")
	.get();

Important

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


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestParameters := &graphconfig.TeamsRequestBuilderGetQueryParameters{
	Filter: "displayName eq 'A Contoso Team'",
	Select: [] string {"id","description"},
}
configuration := &graphconfig.TeamsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

result, err := graphClient.Teams().GetWithRequestConfigurationAndResponseHandler(configuration, nil)

Important

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


Import-Module Microsoft.Graph.Teams

Get-MgTeam -Filter "displayName eq 'A Contoso Team'" -Property "id,description"  -OutFile $outFileId

Important

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


<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestConfiguration = new TeamsRequestBuilderGetRequestConfiguration();

$queryParameters = new TeamsRequestBuilderGetQueryParameters();
$queryParameters->filter = "displayName eq 'A Contoso Team'";
$queryParameters->select = ["id","description"];

$requestConfiguration->queryParameters = $queryParameters;


$requestResult = $graphServiceClient->teams()->get($requestConfiguration);

Important

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

Response

The following is an example of a response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "id": "172b0cce-e65d-44ce-9a49-91d9f2e8493a",
      "description": "This is a Contoso team, used to showcase the range of properties supported by this API"
    }
  ]
}

List teams

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Examples

Example 1: Get a list of teams

Request

Response

Example 2: Use $filter and $top to get two teams with a display name that starts with 'A'

Request

Response

Example 3: Use $filter and $select to get id and description for team with displayName equals "A Contoso Team"

Request

Response

See also

Feedback