Skip to main content
GET
Check whether a workspace handle is free (admin).

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Query Parameters

slug
string
required

candidate workspace handle

Response

200 - application/json

Availability verdict

available
boolean
required
reason
string | null

Why not, when unavailable: taken | reserved | format | too_short.

suggestion
string | null

A free alternative the UI can offer (e.g. hq-2), when taken.