---
title: "Check whether a username is available"
method: GET
path: "/api/auth/signup/availability"
tags: ["Authentication"]
---

# Check whether a username is available

`GET /api/auth/signup/availability`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/auth/signup/availability`
- Auth: none required

Anonymous only. Reveals no more than sign-up's handle-taken refusal and reserves nothing.

## Query parameters

- `handle` string, required

## Response `200`

Response for status 200

- union
  - object
    - `available` true, required
  - object
    - `available` false, required
    - `reason` 'taken' | 'reserved', required

## Other responses

- `400`: The request is invalid.
- `401`: Authentication is required, or the supplied credential is invalid.
- `403`: The credential does not permit this operation. A `code`, when present, names the refusal.
- `404`: The resource does not exist or is not visible to the caller.
- `409`: The request conflicts with the current state. A `code`, when present, names the refusal; `retryable` says whether the same request can succeed later, and `operationId` names the operation in the way.
- `429`: A rate limit is exhausted. Wait Retry-After seconds; the value is a hint, so back off on a repeat 429.
- `503`: A required service is temporarily unavailable; retry later.

---

[API](https://skmtc.dev/gitcafe/apis/git-cafe-api.md) - [All operations](https://skmtc.dev/gitcafe/apis/git-cafe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gitcafe/apis/git-cafe-api/revisions/9fa233d2986d?raw)