Members

Preview an invite by its token, without accepting it

What an invite link is for: the invited email, the workspace, the role, who sent it, and whether it still works. Nothing is accepted or spent. Public: the token is the capability, exactly as for members:accept, and it travels in the body so it never lands in an access log. A link that stopped working says why (accepted, expired, revoked, or replaced by a newer invite to the same address); a token that was never issued is a 404. Rate-limited per client address.

post/members:preview

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/members:preview
  • Auth: none required

Request body

tokenstring required

The invite token from the invite link.

Response

The invite

status'pending' | 'accepted' | 'expired' | 'revoked' | 'replaced' required

pending: the link works. accepted: it was used. expired: it lapsed. revoked: an admin withdrew the invite. replaced: a newer invite was sent to the same address.

emailstring required

The invited address.

role'owner' | 'admin' | 'member' | 'viewer' required
tenant_idstring required
workspace_namestring required

The tenant's display name.

inviter_namestring
inviter_emailstring
invited_atstring date-time
expires_atstring date-time

When the link stops (or stopped) working. Absent when it never expires.

Changes

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