Get Slug Availability

GetSlugAvailability validates and returns whether the slug provided in the URL is available for use. Requests to this endpoint are purposefully slow to mitigate automated enumeration of slugs.

GET /slug/{slug}/availability

Get Slug Availability

cURL

curl --request GET \
  --url https://platform.versori.com/api/organisations/v1/slug/{slug}/availability \
  --header 'Authorization: Bearer <token>'

200

{
  "ok": true,
  "messages": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

slug · string · required

Response

200

application/json

OK

ok · boolean · required

OK is true if the slug is available for use, otherwise false and messages will be populated.

messages · string[] · required

Messages is a list of user-friendly messages describing the problem(s) with this slug. This will always be an empty array if the slug is available.