Skip to content

Preview Invitation

POST /invitations/preview

Unauthenticated by necessity — the recipient has no account yet.

FieldTypeNotes
tokenstringrequiredmin length 16 max length 200
StatusDescriptionBody
200Successful ResponseInvitationPreview
422Validation ErrorHTTPValidationError

The body shows the fields the schema always carries. Which combination is legal is a service rule the schema cannot express, so read the description above before copying this.

Terminal window
curl -X POST https://your-deployment.example.com/invitations/preview \
-H "Content-Type: application/json" \
-d '{
"token": "string"
}'
FieldTypeNotes
organization_namestringrequired—
workspace_namestring | nulloptional—
roleviewer | member | admin | owner | operatorrequired—
emailstring | nulloptional—
expires_atstring (date-time)required—