Docs Menu
Docs Home
/
MongoDB Cloud Manager
/ / / /

Get All Organizations

On this page

  • Resource
  • Request Parameters
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Response Document
  • results Embedded Document
  • Example Request
  • Example Response

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

GET /orgs

This endpoint doesn't use HTTP request path 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
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

This endpoint doesn't 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.

Name
Type
Description
results
array
Array includes one object for each item detailed in the results Embedded Document section.
links
array
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
Integer 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.

Each result is one organization.

Name
Type
Description
id
string
Unique identifier for the organization.
isDeleted
boolean
Flag indicating if the organization is deleted.
name
string
Name of the organization.
links
object array

One or more links to sub-resources and/or related resources. All links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/"
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}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{
"links" : [{
"href" : "https://cloud.mongodb.com/api/public/v1.0/orgs",
"rel" : "self"
}],
"results" : [
{
"id" : "{ORG-ID1}",
"isDeleted": false,
"links": [{
}],
"name" : "Internal Application Support"
},
{
"id" : "{ORG-ID2}",
"isDeleted": false,
"links": [{
}],
"name" : "Customer Application Support"
},
{
"id" : "{ORG-ID3}",
"isDeleted": false,
"links": [{
}],
"name" : "Research and Development"
}
],
"totalCount" : 3
}
← Organizations