invites.preview
POST /api/v1/invites/preview. A signed-in person (Clerk session cookie). Agent tokens are refused. Body limit: 256 KB.
POST
/api/v1/invites/preview
Code sample: Shell / cURL
curl --request POST \ --url https://app.intraface.cc/api/v1/invites/preview \ --header 'Content-Type: application/json' \ --cookie __session=<__session> \ --data '{ "token": "example" }'A signed-in person (Clerk session cookie). Agent tokens are refused. Body limit: 256 KB.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
token
required
string
Example generated
{ "token": "example"}Responses
Section titled “Responses”Success.
Media typeapplication/json
One of:
object
state
required
string
board_id
required
string format: uuid
slug
required
string
role
required
string
object
state
required
string
board
required
role
required
string
inviter
required
members
required
expires_at
required
string format: date-time
object
state
required
string
masked_email
required
string
object
state
required
string
reason
required
string
board_title
required
string | null
Example
{ "state": "member", "role": "owner"}default
Section titled “default”Any error: see error.code.
Media typeapplication/json
object
error
required
object
code
required
A stable error code: see the error codes table in the API overview.
string
message
required
string
hint
string
details
Example generated
{ "error": { "code": "example", "message": "example", "hint": "example", "details": "example" }}