---
title: "Check name availability"
method: GET
path: "/v1/names/{name}"
tags: ["mailboxes"]
---

# Check name availability

`GET /v1/names/{name}`

## Request

- Base URL: `https://botmail.pro`
- URL: `https://botmail.pro/v1/names/{name}`
- Auth: one of:
  - none
  - HTTP bearer
  - API key in cookie `bm_session`

No auth needed. Signed-in callers get answers for their plan (short
names); anonymous and pending callers get free-plan answers.
Rate limit: 60/minute per IP.

## Path parameters

- `name` string, required

## Response `200`

Availability. `message` and `hint` are set when unavailable.

- NameCheck
  - `name` string, required
  - `available` boolean, required
  - `reason` '' | 'invalid' | 'reserved' | 'short_name_requires_paid_plan' | 'taken' | 'held' | 'retired', required: Empty when available.
  - `short` boolean, required: 4 characters or fewer.
  - `message` string
  - `hint` string

## Other responses

- `429`: Too many requests (`rate_limited`, `invite_limit`). Wait `Retry-After` seconds.

---

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