---
title: "Check whether a valid handle is available during onboarding."
method: GET
path: "/api/v1/me/handle-availability"
---

# Check whether a valid handle is available during onboarding.

`GET /api/v1/me/handle-availability`

## Request

- Base URL: `https://portamora.app`
- URL: `https://portamora.app/api/v1/me/handle-availability`
- Auth: API key in cookie `__Host-session`

Requires a browser session. Limited to 60 checks per account per minute. Results use Cache-Control: no-store and do not reserve a handle; onboarding still enforces uniqueness.

## Query parameters

- `handle` string, required

## Response `200`

Current handle availability.

- object
  - `handle` string, required
  - `available` boolean, required

## Other responses

- `400`: Invalid input or expired sign-in link.
- `401`: Authentication required.
- `403`: Missing scope, browser session, fresh sign-in, or matching Origin.
- `404`: Missing resource or resource owned by someone else.
- `409`: Conflicting handle, idempotency key, or version state.
- `410`: The upload window has expired. Allocate a new upload with a new key.
- `413`: Request body or uploaded file exceeds its limit.
- `429`: Rate limit reached. Retry-After header and details.retryAt give the next allowed attempt.
- `503`: Temporarily unavailable.

---

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