Validate organization slug availability

GET

/v1/organizations/check-slug/:slug

Validate organization slug availability

Required Permission: base.organization.management.checkSlug

Validates whether proposed organization slug identifier is available for use, not reserved by system, and conforms to naming conventions before creation.

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

slug string

required

URL-friendly workspace identifier enabling human-readable access paths and custom branding in dashboard URLs and API endpoints.

≤ 128 characters · ≥ 3 characters · Match pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$

Responses

200 Response application/json

status boolean optional

data object optional

valid boolean optional

Flag indicating whether proposed organization slug is available for use and meets naming requirements.

reason string optional

Explanation for slug validation result describing availability status or specific naming constraint violation.

≤ 128 characters

{
    "status": true,
    "data": {
        "valid": true,
        "reason": ""
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}