What an invitation link is for
POST
/api/v1/invitations/preview
const url = 'https://api.crossmart.io/api/v1/invitations/preview';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"token":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.crossmart.io/api/v1/invitations/preview \ --header 'Content-Type: application/json' \ --data '{ "token": "example" }'Open to anyone with the link, so it can be shown before signing in. 404 when the link is unknown, used, revoked or expired.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
token
required
string
Example generated
{ "token": "example"}Responses
Section titled “Responses”Media typeapplication/json
object
workspaceName
required
The workspace’s display name
string
inviterName
required
string
email
required
The address invited; accepting needs an account with it
string
role
required
string
roleName
required
The role as people read it
string
expiresAt
required
string format: date-time
Example
{ "role": "OWNER", "roleName": "Editor"}