CustomDomain™ docs
API referenceMembers

Preview an invite by its token, without accepting it

POST
/members:preview

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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/members:preview" \  -H "Content-Type: application/json" \  -d '{    "token": "string"  }'
{  "status": "pending",  "email": "string",  "role": "owner",  "tenant_id": "string",  "workspace_name": "string",  "inviter_name": "string",  "inviter_email": "string",  "invited_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}