organizations

Preview Invitation

Changed on

Look up an invitation by raw token without consuming it.

The caller is always authenticated (the accept-invite page is behind sign-in), so the cap below is per person. The response omits the inviter's identity, since anyone holding a leaked token (referer header, log line, browser history) can reach this endpoint.

get/api/v0/invitations/{token}/preview

Request

Path parameters

tokenstring required

Response

Successful Response

public_idstring uuid required

The public id of the invitation.

organization_namestring required

The name of the inviting organization.

email_maskedstring required

Partially-masked invitee email (e.g. 'a***@e***.com'). The full address is never exposed on this unauth endpoint.

rolestring required

The role the invitee will receive on accept.

statusstring required

pending, accepted, or revoked. Expiry is derived from expires_at; an unredeemed invitation past it stays pending.

availability'pending' | 'accepted' | 'revoked' | 'expired' required

What the invitation is now: pending only while it can still be accepted, expired once a pending one is past expires_at.

expires_atstring date-time required

When the invitation expires.

Changes