---
title: "Check slug availability"
method: GET
path: "/v1/slugs/availability"
tags: ["Spaces"]
---

# Check slug availability

`GET /v1/slugs/availability`

## Request

- Base URL: `https://api.spacefast.com`
- URL: `https://api.spacefast.com/v1/slugs/availability`
- Auth: HTTP bearer

Checks whether a space or team slug is available and suggests an alternative when it is taken.

## Query parameters

- `kind` 'team' | 'space', required: Which kind of slug to check: a space slug or a team slug.
- `slug` string: Slug to check. It is normalized first, and the verdict describes the normalized form.
- `currentSlug` string: The resource's current slug, when renaming. A slug that normalizes to this one stays available instead of colliding with itself.
- `teamId` string: Team the space would belong to. Space slugs and their managed hostnames are checked inside that team; ignored for `kind=team`.

## Response `200`

Response for status 200

- object
  - `$schema` string, uri: Canonical JSON Schema URL for this response body. The server also sends it in the `Link: rel="describedby"` response header.
  - `data` object, required
    - `kind` 'team' | 'space', required: Resource kind the slug was checked for.
    - `normalizedSlug` string, required: Slug after normalization; empty when nothing usable.
    - `available` boolean, required: Whether the normalized slug can be used as-is.
    - `suggestion` string, nullable, required: Closest available slug when the requested one is taken; null when available.
    - `hostnameAvailable` boolean: Whether the normalized slug's managed hostname can be used as-is.
    - `hostnameSuggestion` string, nullable: Closest available public name when the managed hostname is taken.
    - `selectedHostname` string, nullable: Managed hostname selected for the requested slug.
    - `hostnameConflictReason` string, nullable: Stable reason code for the selected hostname conflict, when unavailable.
    - `globalHostnameAvailable` boolean: Whether `{slug}.space.fast` is available. A label is one identity across every managed apex.
    - `globalHostname` string, nullable: The global managed hostname checked.
    - `globalHostnameSuggestion` string, nullable: Closest available global public name when `{slug}.space.fast` is taken.

## Other responses

- `default`: Problem details (RFC 9457). Any 4xx/5xx response is one `application/problem+json` document.

---

[API](https://skmtc.dev/spacefast/apis/spacefast-api.md) · [All operations](https://skmtc.dev/spacefast/apis/spacefast-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spacefast/apis/spacefast-api/revisions/bd165bc7c983?raw)