- API >
- Public API Resources >
- Projects and Users >
- Projects >
- Get All Project Invitations
Get All Project Invitations¶
On this page
Retrieves all pending invitations to the specified Cloud Manager project.
Required Roles¶
You can successfully call this endpoint with the
Project User Admin
role.
Resource¶
Base URL: https://cloud.mongodb.com/api/public/v1.0
Request Path Parameters¶
Path Element | Type | Necessity | Description |
---|---|---|---|
GROUP-ID | string | Required | Unique 24-hexadecimal digit string that identifies the project. |
Request Query Parameters¶
The following query parameters are optional:
Name | Type | Necessity | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a prettyprint format. | false |
||||||
envelope | boolean | Optional | Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes:
|
false |
username | string | Optional | Email address of the invited user. This is the address to which Cloud Manager sent the invite. If omitted, Cloud Manager returns all pending invitations. |
---|
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
The response JSON document includes an array of objects. Each object represents one invitation to the Cloud Manager project.
Name | Type | Description |
---|---|---|
createdAt | string | Timestamp in ISO 8601 date and time format in UTC when Cloud Manager sent the invitation. |
expiresAt | string | Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Tip Users have 30 days to accept an invitation to an Cloud Manager project. |
groupId | string | Unique 24-hexadecimal digit string that identifies the project. |
groupName | string | Name of the project. |
id | string | Unique 24-hexadecimal digit string that identifies the invitation. |
inviterUsername | string | Cloud Manager user who invited username to the project. |
roles | array of strings | Cloud Manager roles to assign to the invited user. If the user accepts the invitation, Cloud Manager assigns these roles to them. |
username | string | Email address to which Cloud Manager sent the invitation. If the user accepts the invitation, they use this email address as their Cloud Manager username. |