Teams - Get Team Members With Extended Properties

  • Reference
Service:
Core
API Version:
6.0

Get a list of members for a specific team.

GET https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams/{teamId}/members?api-version=6.0
With optional parameters: 
GET https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams/{teamId}/members?$top={$top}&$skip={$skip}&api-version=6.0

URI Parameters

Name In Required Type Description
organization
 path True

string

The name of the Azure DevOps organization.
projectId
 path True

string

The name or ID (GUID) of the team project the team belongs to.
teamId
 path True

string

The name or ID (GUID) of the team .
api-version
 query True

string

Version of the API to use. This should be set to '6.0' to use this version of the api.
$skip
 query

integer

int32
$top
 query

integer

int32

Responses

Name Type Description
200 OK

TeamMember[]

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.profile Grants the ability to read your profile, accounts, collections, projects, teams, and other top-level organizational artifacts.
vso.project Grants the ability to read projects and teams.

Examples

Sample Request

GET https://dev.azure.com/fabrikam/_apis/projects/eb6e4656-77fc-42a1-9181-4c6d8e9da5d1/teams/564e8204-a90b-4432-883b-d4363c6125ca/members?api-version=6.0

Sample Response

Status code:
200 
{
  "value": [
    {
      "isTeamAdmin": false,
      "identity": {
        "id": "3b5f0c34-4aec-4bf4-8708-1d36f0dbc468",
        "displayName": "Christie Church",
        "uniqueName": "fabrikamfiber1@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/3b5f0c34-4aec-4bf4-8708-1d36f0dbc468",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=3b5f0c34-4aec-4bf4-8708-1d36f0dbc468"
      }
    },
    {
      "isTeamAdmin": false,
      "identity": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      }
    },
    {
      "isTeamAdmin": true,
      "identity": {
        "id": "19d9411e-9a34-45bb-b985-d24d9d87c0c9",
        "displayName": "Johnnie McLeod",
        "uniqueName": "fabrikamfiber2@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/19d9411e-9a34-45bb-b985-d24d9d87c0c9",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=19d9411e-9a34-45bb-b985-d24d9d87c0c9"
      }
    }
  ],
  "count": 3
}

Definitions

Name Description
IdentityRef
ReferenceLinks

The class to represent a collection of REST reference links.
TeamMember

IdentityRef

Name Type Description
_links

ReferenceLinks

This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor

string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
directoryAlias

string

Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
displayName

string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
id

string

imageUrl

string

Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive

boolean

Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity

boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName

string

Deprecated - use Domain+PrincipalName instead
url

string

This url is the full route to the source resource of this graph subject.

The class to represent a collection of REST reference links.

Name Type Description
links

object

The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

TeamMember

Name Type Description
identity

IdentityRef

isTeamAdmin

boolean