Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas organizations invitations list

On this page

  • Syntax
  • Options
  • Inherited Options
  • Examples

Return all pending invitations to your organization.

To use this command, you must authenticate with a user account or an API key with the Organization User Admin role.

Command Syntax
atlas organizations invitations list [options]
Name
Type
Required
Description

--email

string

false

Email address for the user.

-h, --help

false

help for list

--orgId

string

false

Organization ID to use. This option overrides the settings in the configuration file or environment variable.

-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.

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.

# Return a JSON-formatted list of pending invitations to the organization with the ID 5f71e5255afec75a3d0f96dc:
atlas organizations invitations list --orgId 5f71e5255afec75a3d0f96dc --output json

Back

invite