Navigation

Get All Teams

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

Request Path Parameters

Path Element Required/Optional Description
ORG-ID Required. The unique identifier for the organization whose teams you want to retrieve.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Display 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 This array includes one object for each item detailed in the results array section.
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.
totalCount number The 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.

Name Type Description
id ObjectId Unique identifier for the team.
name string Name of the team.

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/7253g4s820thk69bfecd7bv1/teams?pretty=true"

Example Response

{
        "links": [{
               "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/7253g4s820thk69bfecd7bv1/teams?pageNum=1&itemsPerPage=100",
               "rel": "self"
        }],
        "results": [{
                "id": "b5cfec387d9d63926b9189g",
                "name": "Finance"
        }, {
                "id": "6b610e4f80eef5366613e4df",
                "name": "Research and Development"
        }, {
                "id": "6b610e1087d9d66b272f0c86",
                "name": "Technical Documentation"
        }],
        "totalCount": 3
}
←   Teams Get One Team by ID  →