Sign in
Users

Retrieve invitation by ID or token

Retrieve invitation details using either numeric ID or secure token.

ID Lookup: Standard numeric ID for internal references Token Lookup: Secure token for public invitation links

Token Format: UUID-based secure token from invitation email links Security: Only active, non-expired invitations are returned

Use Cases:

  • Displaying invitation details on acceptance page
  • Verifying invitation validity
  • Pre-filling user registration forms
get/invitations/{id}

Response

OK

idinteger
invitee_emailstring required
invitation_tokenstring
expires_atstring date-time

Timestamp when the invitation will expire.

organizationinteger
created_atstring date-time

Timestamp when the invitation was created.

existing_userstring
organization_does_not_existboolean
invitation_unique_keystring

Changes

No recorded changes to this endpoint across all 1 revision of this API.