MOmongodb
Organizations

Return One Invitation in One Organization by Invitation ID

Returns the details of one pending invitation to the specified organization.

Note: Invitation management APIs are deprecated. Use Return One MongoDB Cloud User in One Organization to return a pending user.

get/api/atlas/v2/orgs/{orgId}/invites/{invitationId}

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

orgIdstring required
Example:4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

invitationIdstring required

Unique 24-hexadecimal digit string that identifies the invitation.

Query parameters

envelopeboolean

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.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.