Return All Projects

Returns details about all projects. Returns only the first 1000 projects unless set differently by the user in the advanced action parameters. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Read Write role. This resource does not require the API Key to have an Access List.

Parameters

Parameter	Description
Envelope	Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
Include Count	A flag that indicates whether the response also returns the total number of items (totalCount).
Items Per Page	The returned project items are grouped in pages. This parameter determines the number of items that the response returns per page.
Page Number	The returned project items are grouped in pages. This parameter determines the page number of the current set of the total objects that the response returns.
Pretty	Flag that indicates whether the response body should be in the prettyprint format.

Example Output

{
    "links": [
        {
            "href": "https://mms.mongodb.com/api/atlas/v1.0/groups/{groupId}/serverless/{instanceName1}/backup/snapshots",
            "rel": "https://mms.mongodb.com/snapshots"
        }
    ],
    "results": [
        {
            "clusterCount": 0,
            "created": "2019-08-24T14:15:22Z",
            "id": "32b6e34b3d91647abb20e7b8",
            "links": [
                {
                    "href": "https://mms.mongodb.com/api/atlas/v1.0/groups/{groupId}/serverless/{instanceName1}/backup/snapshots",
                    "rel": "https://mms.mongodb.com/snapshots"
                }
            ],
            "name": "string",
            "orgId": "4888442a3354817a7320eb61"
        }
    ],
    "totalCount": 0
}

Workflow Library Example

Return All Projects with Mongodb Atlas and Send Results Via Email

Preview this Workflow on desktop