Sign in
User Invitations

Preview an invitation (public — used from the email link)

Preview an invitation (public — used from the email link)

get/api/v1/user-invitations/preview

Query parameters

tokenstring required

Raw invitation token from the email link

Raw invitation token from the email link

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "email": "invitee@example.com",
    "scope_name": "Acme Corp",
    "role": "admin",
    "expires_at": "2026-02-12T00:00:00.000Z",
    "status": "pending"
  }
}

Changes

Changed in 2 of the 8 revisions of this API.11