---
title: "Check Handle Available"
method: GET
path: "/api/profile/handle-available"
tags: ["profiles"]
---

# Check Handle Available

`GET /api/profile/handle-available`

## Request

- Base URL: `https://api.parlel.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.parlel.com/api/profile/handle-available`
- Auth: none declared

Whether the editor may offer ``handle``. Advisory, never authoritative.

The answer is a boolean and a coarse reason. It never says who holds a taken
handle, because "taken" is the entire answer a client needs in order to pick
another one, and the alternative is a lookup service that maps handles to
people. Requires a session so that walking the namespace costs an account —
see the module docstring on enumeration.

Your own current handle comes back ``available: true``. Opening the editor and
pressing Save without touching the field must not be told that you are already
using your own name.

A shape violation is a ``false`` with ``reason: "invalid"``, not a 422. This is
called as the user types, and "you have typed two characters so far" is not a
client error.

## Query parameters

- `handle` string, required

## Headers

- `authorization` string, nullable

## Response `200`

Successful Response

- object

## Other responses

- `422`: Validation Error

---

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