Navigation

Get One Team by ID

The Atlas API uses HTTP Digest Authentication. Provide your Atlas username and API key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

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

Syntax

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

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 information you want to retrieve.

Request Query Parameters

Field Required/Optional Description
envelope Optional.

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

Defaults to false.

pretty Optional.

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

Defaults to false.

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

Name Type Description
id string The unique identifier for the team.
name string The name of the organization associated with the team.
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.

Example Request

curl --user "{username:apiKey}"" --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"

Example Response

{
 "id": "{TEAM-ID}",
 "links": [
     {
         "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}",
         "rel": "self"
     }
 ],
 "name": "myNewTeam"
}