Skip to main content
POST
Join a workspace with an invite link's token

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Body

application/json
token
string
required

The token from the link (#/invite/{token}).

Response

Joined, or already a member. Either way the workspace is now the caller's active one.

ok
enum<boolean>
required
Available options:
true
joined
boolean
required

False: the caller was already a member, and nothing changed but the active workspace.

tenant_id
string
required
workspace
object
required
role
string
required

The caller's role in the workspace.