- API >
- API Resources >
- Projects
Get Teams Assigned to a Project¶
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.
https://cloud.mongodb.com/api/atlas/v1.0
Syntax¶
GET /groups/{GROUP-ID}/teams
Request Path Parameters¶
| Path Element | Required/Optional | Description |
|---|---|---|
GROUP-ID | Required. | The unique identifier for the project. |
Request Query Parameters¶
| Field | Required/Optional | Description |
|---|---|---|
pageNum | Optional. | The page to return. Defaults to |
itemsPerPage | Optional. | Number of items to return per page, up to a maximum of 500. Defaults to |
includeCount | Optional. | Specifies whether the response returns the Defaults to |
envelope | Optional. | A boolean that specifies whether or not to wrap the response in an envelope. Defaults to |
pretty | Optional. | A boolean that specifies whether or not to return a "pretty-printed" JSON document. Defaults to |
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 team assigned to the
project.
| Name | Type | Description |
|---|---|---|
links | object array | This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
roleNames | string array | Array of project roles assigned to the team. |
teamId | string | The unique identifier for the team. |
Example¶
Request¶
curl -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/teams?pretty=true"
Response¶
{ "links": [ { "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/teams", "rel": "self" } ], "results": [ { "links" : [ { "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/teams/{TEAM-ID}", "rel": "self" } ], "roleNames": [ "GROUP_READ_ONLY" ], "teamId": "{TEAM-ID}" } ], "totalCount": 1 }