Skip to main content
GET
Preview Invitation

Query Parameters

token
string
default:""

Response

Successful Response

What the accept-invite page needs to render the right view up front.

status is the invitation's state, not an error: the page can only tell an invitee "this link was already used" instead of showing them a password form that is going to fail if it can ask before they type anything. Identifying fields are present only when the token is actually redeemable.

status
string
required
email
string | null
name
string | null
roles
string[]
role_label
string | null
workspace_name
string | null
expires_at
string<date-time> | null
require_2fa
boolean
default:false