Navigation

Get Teams Assigned to a Project

Info With Circle IconCreated with Sketch.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.

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

GET /groups/{GROUP-ID}/teams
Path ElementRequired/OptionalDescription
GROUP-IDRequired.The unique identifier for the project.
FieldRequired/OptionalDescription
pageNumOptional.

The page to return.

Defaults to 1.

itemsPerPageOptional.

Number of items to return per page, up to a maximum of 500.

Defaults to 100.

includeCountOptional.

Specifies whether the response returns the totalCount field.

Defaults to true.

envelopeOptional.

A boolean that specifies whether or not to wrap the response in an envelope.

Defaults to false.

prettyOptional.

A boolean that specifies whether or not to return a "pretty-printed" JSON document.

Defaults to false.

This endpoint does not use HTTP request body parameters.

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.

NameTypeDescription
resultsobject arrayIncludes one object for each item detailed in the results array section.
linksobject arrayIncludes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCountnumberCount 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.

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

NameTypeDescription
linksobject 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.

roleNamesstring arrayArray of project roles assigned to the team.
teamIdstringThe unique identifier for the team.
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"
{
"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
}
Give Feedback