API >
API Resources >
Teams >
Get All Users Assigned to a Team

Get All Users Assigned to a Team¶

On this page

Syntax
Response
- Response Document
- results array
Example Request
Example Response

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

Syntax¶

copy

GET /orgs/{ORG-ID}/teams/{TEAM-ID}/users

Request Path Parameters¶

Path Element	Required/Optional	Description
`ORG-ID`	Required	The unique identifier for the organization associated with the team.
`TEAM-ID`	Required	The unique identifier of the team whose user membership you want to retrieve.

Request Query Parameters¶

The following query parameters are optional:

Name	Type	Description	Default
`pageNum`	integer	Page number (1-based).	`1`
`itemsPerPage`	integer	Number of items to return per page, up to a maximum of 500.	`100`
`includeCount`	boolean	Specifies whether the response returns the `totalCount` field.	`true`
`pretty`	boolean	Displays response in a prettyprint format.	`false`
`envelope`	boolean	Specifies whether or not to wrap the response in an envelope.	`false`

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

Response Document¶

The response JSON document includes an array of result objects, an array of link objects, and a count of the total number of result objects retrieved.

Name	Type	Description
`results`	object array	Includes one object for each item detailed in the results array section.
`links`	object array	Includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
`totalCount`	number	Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results array¶

Each element in the result array is one user assigned to the team.

Name	Type	Description
`emailAddress`	string	The email address associated to the user.
`firstName`	string	The first name of the user.
`id`	string	The unique identifier for the team.
`lastName`	string	The last name of the user.
`links`	object array	One or more links to sub-resources and/or related resources. The relation-types between URLs are explained in the Web Linking Specification.
`roles`	array	Each object in the `roles` array represents the Atlas organization role the user has for the associated `orgId` or `groupId`.
`roles.orgId`	string	ID of the organization where the user has the assigned `roles.roleName` organization role.
`roles.groupId`	string	ID of the project where the user has the assigned `roles.roleName` project role.
`roles.roleName`	string	The organization role assigned to the user for the specified `roles.orgId` or `roles.groupId`.
`teamsId`	array	Array of string IDs for each team the user is a member of.
`username`	string	Username associated to the user.

Example Request¶

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest -i \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request GET "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=true"

Example Response¶

copy

{
 "links": [
     {
         "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pageNum=1&itemsPerPage=100",
         "rel": "self"
     }
 ],
 "results": [
     {
         "emailAddress": "AtlasUser@example.com",
         "firstName": "Atlas",
         "id": "{USER-ID}",
         "lastName": "User",
         "links": [
             {
                 "href": "https://cloud.mongodb.com/api/atlas/v1.0/users/{USER-ID}",
                 "rel": "self"
             }
         ],
         "roles": [
             {
                 "groupId": "{GROUP-ID}",
                 "roleName": "GROUP_OWNER"
             },
             {
                 "orgId": "{ORG-ID}",
                 "roleName": "ORG_OWNER"
             }
         ],
         "teamIds": [
             "{TEAM-ID}"
         ],
         "username": "AtlasUser@example.com"
     }
 ],
 "totalCount": 1
}

← Get One Team by Name Create a Team →