Check Custom URL Availability

GET 
/organizations/check-url/:customUrl

Check if a custom URL is available for organization registration. This endpoint is publicly accessible (no auth required) to allow URL validation during the registration flow before org creation.

Request

Path Parameters

customUrl stringrequired

The custom URL to check (path parameter)

Responses

200

application/json

Schema

Schema

available booleanrequired

Whether the URL is available

customUrl stringrequired

The URL that was checked

Example (from schema)

{
  "available": true,
  "customUrl": "string"
}

Example

{
  "available": true,
  "customUrl": "my-company"
}

Error 4xx

Invalid custom URL format

application/json

Schema

Schema

ValidationError required

Invalid custom URL format

Example (from schema)

{}

Example

{}

Loading...