Navigation

Get All Organizations

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

Syntax

GET /api/public/v1.0/orgs/

Request Parameters

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

Field Required/Optional Description
pageNum Optional.

The page to return.

Defaults to 1.

itemsPerPage Optional.

Maximum number of items to return per page.

Defaults to 100.

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.

The HTTP response returns a JSON document that includes the following objects:

results

An array of documents, each representing an organization that the authenticated user has access to.

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

totalCount

The total number of items in the result set. This value may be higher than the number of objects in the results array if the entire result set is paginated.

Examples

Example Request

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

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

{
  "links" : [
     {
       "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs",
       "rel" : "self"
     }
  ],
  "results" : [
     {
       "id" : "5a2add1cfd9f3cfb17053317",
       "name" : "Internal Application Support"
     },
     {
       "id" : "5a2add1cfd9f3cfb17053318",
       "name" : "Customer Application Support"
     },
     {
       "id" : "5a2add1cfd9f3cfb17053319",
       "name" : "Research and Development"
     }
  ],
  "totalCount" : 3
}