Navigation

Get One Team by ID

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 /orgs/{ORG-ID}/teams/{TEAM-ID}
Path ElementRequired/OptionalDescription
ORG-IDRequired.The unique identifier for the organization associated with the team.
TEAM-IDRequiredThe unique identifier of the team whose information you want to retrieve.
FieldRequired/OptionalDescription
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.

NameTypeDescription
idstringThe unique identifier for the team.
namestringThe name of the organization associated with the team.
linksobject arrayOne or more links to sub-resources and/or related resources. The relation-types between URL s are explained in the Web Linking Specification.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}"" --digest -i \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
"https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}?pretty=true"
{
"id": "{TEAM-ID}",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}",
"rel": "self"
}
],
"name": "myNewTeam"
}
Give Feedback