Navigation

Get One Organization

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

Syntax

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

Request Path Parameters

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

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

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.

Examples

Example Request

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

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body

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