atlas organizations list
On this page
Return all organizations.
To use this command, you must authenticate with a user account or an API key with the Organization Member role.
Syntax
Command Syntax
atlas organizations list [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for list | |
--includeDeleted | false | Flag that indictaes whether to include deleted organizations in the list. This option applies only to Ops Manager organizations. You can't return deleted Atlas or Cloud Manager organizations. | |
--limit | int | false | Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. |
--name | string | false | Organization name to perform a case-insensitive search for. |
--omitCount | false | Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. |
--page | int | false | Page number that specifies a page of results. This value defaults to 1. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ID NAME <Id> <Name>
Examples
# Return a JSON-formatted list of all organizations: atlas organizations list --output json
# Return a JSON-formatted list that includes the organizations named org1 and Org1, but doesn't return org123: atlas organizations list --name org1 --output json