Check whether a candidate org slug is available.

GET

/v1/organizations/slug-availability

const url = 'https://api.adversarial.com/api/v1/organizations/slug-availability?candidate=example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.adversarial.com/api/v1/organizations/slug-availability?candidate=example'

Parameters

Query Parameters

candidate

required

string

The candidate slug to check.

Responses

200

Slug availability result

application/json

One of:

object

status

required

string

Allowed values: AVAILABLE

The slug is well-formed but claimed by the platform — a route name or an auth path. Reported separately from INVALID so it can be shown as unavailable rather than malformed.

object

status

required

string

Allowed values: RESERVED

Example

{
  "status": "AVAILABLE"
}