Navigation

Get One Organization

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}
Path ElementRequired/OptionalDescription
ORG-IDRequired.The unique identifier for the Atlas organization whose information you want to retrieve.

The following query parameters are optional:

Query ParameterTypeDescriptionDefault
prettybooleanDisplays response in a prettyprint format.false
envelopebooleanSpecifies whether or not to wrap the response in an envelope.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.
NameTypeDescription
idObjectIdUnique identifier for the organization.
isDeletedbooleanFlag indicating if the organization is deleted.
namestringName of the organization.
linksdocument 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 --include --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
"https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}?pretty=true"
{
"id" : "5a2add1cfd9f3cfb17053318",
"isDeleted": false,
"links": [{
"href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5a2add1cfd9f3cfb17053318",
"rel": "self"
}, {
"href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5a2add1cfd9f3cfb17053318/groups",
"rel": "http://mms.mongodb.com/groups"
}, {
"href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5a2add1cfd9f3cfb17053318/teams",
"rel": "http://mms.mongodb.com/teams"
}, {
"href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5a2add1cfd9f3cfb17053318/users",
"rel": "http://mms.mongodb.com/users"
}],
"name" : "Customer Application Support"
}
Give Feedback