Sign in
Invitations

Retrieve an invitation

Retrieves the invitation by its ID, including the invitation link.

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

Request

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

Path parameters

idstring required

The id of the invitation

tenantstring required

Response

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