Skip to main content
GET
Check whether a project handle is free

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

handle
string
required

The handle a customer would like to use.

Required string length: 1 - 120

Response

Whether the handle is usable, and alternatives when it is not.

handle
string
required

The handle exactly as it was asked about.

available
boolean
required

True when a project may take this handle now.

alternatives
string[]
required

Free handles to offer instead, empty when the handle is available.

Maximum array length: 5
reason
enum<string>

Why the handle cannot be used. Absent when it is available.

Available options:
taken,
too_short,
too_long,
invalid_shape,
prohibited_word