Navigation

Get One Organization

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

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

Base URL: https://cloud.mongodb.com/

Resource

GET /api/atlas/v1.0/orgs/{ORG-ID}

Request Path Parameters

Path Element Required/Optional Description
ORG-ID Required. The unique identifier for the Atlas organization 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.

Response

If you set the query element envelope to true, the response is wrapped by the content object.

Name Description
id The unique identifier of the organization.
name The name of the organization.

Example Request

curl --include --user "username:apiKey" \
  --digest "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5a2add1cfd9f3cfb17053318/"

Example Response

{
  "id" : "5a2add1cfd9f3cfb17053318",
  "name" : "Customer Application Support"
}