Check if organization slug or shortCode is available

GET

/api/organizations/check-availability

const url = 'https://example.com/api/organizations/check-availability';
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://example.com/api/organizations/check-availability

Parameters

Query Parameters

slug

string

shortCode

string

excludeOrgId

string format: uuid

Responses

200

Availability response

application/json

object

slugAvailable

required

Flag indicating if the organization URL slug is available.

boolean

shortCodeAvailable

required

Flag indicating if the organization short code is available.

boolean

Example

{
  "slugAvailable": true,
  "shortCodeAvailable": true
}

400

Invalid request