INVITES

Preview an invitation

POST rather than GET because the token is in the body, not the path — see the module docstring. Returns 410 with a specific error_type for expired / revoked / already-accepted invites so the page can tell the invitee what to do next, and 404 when the token doesn't resolve at all (typically because a resend replaced it).

post/internal/api/invites/preview

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Request body

tokenstring required

Response

Successful Response

tenant_namestring required
emailstring required
role'OWNER' | 'ADMIN' | 'USER' | 'SUPER_ADMIN' | 'REVIEWER' | 'PREPARER' | 'MANAGER' required
expires_atstring date-time required
invited_by_namestring nullable

Changes

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