Chelabase
Login apiLogin

Describe Invite

POST
/auth/v1/invite

Describes an open invite for the accept page: who invited the visitor, and to which workspace. The invite link's own token (t) is the credential, so this spends no code. It is a POST so that the user id and the token are never in a URL. A closed (accepted, revoked or expired) invite, a wrong or missing user or token, and a malformed value all answer the same not_found.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Both fields default to empty, so a missing one is a not_found like a wrong one.

t?string

The invite token from the invite link.

user?string

The identity user id from the invite link.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/auth/v1/invite" \  -H "Content-Type: application/json" \  -d '{}'
{  "inviter_email": "string",  "inviter_name": "string",  "tenant_name": "string"}