Skip to main content
POST
Preview a workspace invite

Body

application/json

The ticket an invite link carries. A body field: a ticket never rides in a URL.

ticket
string
required

The value of the invite link's __clerk_ticket parameter, as the link carries it.

Required string length: 1 - 4096

Response

Successful Response

What an invite link offers: the join page's words, and nothing else.

email_address
string
required

The address the invite was sent to.

expires_at
string<date-time> | null
required

When the invite stops working.

inviter_name
string | null
required

The full name of the teammate who sent the invite; null when unknown.

status
enum<string>
required

Whether the invite can still be used: pending until someone joins with it, then accepted; expired past its date, revoked when a teammate took it back.

Available options:
pending,
accepted,
expired,
revoked
workspace_logo_url
string | null
required

The workspace's logo; null when it has none, and its initial is shown.

workspace_name
string
required

The name of the workspace the invite is to.