Sign in
Invitations

Retrieve all invitations for a given email

Returns all invitations created for a given email address in the current tenant.

get/api/v1/{tenant}/invitations/email/{email}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/invitations/email/{email}
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

emailstring required

The email address of the invited

tenantstring required

Response

listInvitationsByEmail 200 response

idstring
tenantIdstring
emailstring
status'PENDING' | 'ACCEPTED' | 'EXPIRED'
sentAtstring date-time
expiredAtstring date-time
acceptedAtstring date-time
superAdminboolean
linkstring

Example response

[
  {
    "roles": [
      {
        "isDefault": true,
        "name": "name",
        "id": "id",
        "isManaged": true
      }
    ],
    "groups": [
      {
        "name": "name",
        "id": "id"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 7 revisions of this API.