---
title: "Check name availability"
method: GET
path: "/workspace/vanityname/check"
tags: ["Workspaces"]
---

# Check name availability

`GET /workspace/vanityname/check`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/workspace/vanityname/check`
- Auth: none declared

## Query parameters

- `name` string, required

## Response `200`

- VanityNameCheckResponse
  - `name` string, required
  - `available` boolean, required
  - `reason` string, nullable, required

---

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