Navigation

Get All Organizations

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

Resource

GET /orgs

Request Parameters

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

The following query parameters are optional:

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Number of items to return per page, up to a maximum of 500. 100
pretty boolean Displays response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false
name string

Filters results based on the specified organization name. Performs a case-insensitive search for organizations which exactly match the specified name.

Example

If you specify a name query parameter of org1, Cloud Manager returns organizations named org1 and Org1, but would not return an organization named org123.

None

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 Embedded Document 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 Embedded Document

Each result is one organization.

Name Type Description
id string Unique identifier for the organization.
name string Name of the team.
links object array One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification

Example Request

curl --user '{USERNAME}:{APIKEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET "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" : "{ORG-ID1}",
      "links": [{

      }],
      "name" : "Internal Application Support"
    },
    {
      "id" : "{ORG-ID2}",
      "links": [{

      }],
      "name" : "Customer Application Support"
    },
    {
      "id" : "{ORG-ID3}",
      "links": [{

      }],
      "name" : "Research and Development"
    }],
  "totalCount" : 3
}