Skip to main content
POST
See what a claim token would take over

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
claim_token
string
required

hkc_…, from the registration response (or the #/claim/{token} link).

Response

What claiming would take over.

account
object
required
workspace
object
required
suspended
boolean
required

True when an operator suspended the workspace: it cannot be claimed until reinstated.