Check slug availability

​

Checks whether an organization slug is available.

The slug is normalized before checking (lowercased, unicode transliterated, spaces converted to hyphens) and the normalized form is returned in the response.

This is an advisory check — the slug could be claimed between the check and a subsequent create request. The POST /orgs endpoint enforces uniqueness as the final authority.

Permissions
Key type Accepted Permission required Notes
Org API key yes org:read Slug space is global — the check applies across all orgs
Personal API key yes org:read Requires X-Org-ID matching an org the caller belongs to
Error Codes
Code HTTP Description
authorize.unauthenticated 401 No valid auth credentials
authorize.forbidden 403 Missing org:read permission or wrong org
org.slug_check.invalid 400 Slug fails format or length validation
org.slug_check.failed 500 Database lookup failed
Query Parameters
  • slug
    Type: string
    required

    Slug to check (e.g. acme-corp)

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/orgs/check-slug
curl 'https://api.nametrust.com/orgs/check-slug?slug='

{
  "object": "org_slug_check",
  "slug": "acme-corp",
  "available": true
}

Slug check result