Skip to main content

GET /api/v1/usernames/check

Check whether a username is valid, normalized, and currently available.

Auth​

No auth required.

Request​

GET /api/v1/usernames/check?username=pat

Query parameters​

NameTypeRequiredDescription
usernamestringYesThe username to validate

Success response​

{
  "available": true,
  "normalized": "pat",
  "reason": null
}

Invalid or reserved response​

{
  "available": false,
  "normalized": "docs",
  "reason": "reserved"
}

reason can be:

  • invalid
  • reserved
  • null

Notes​

  • Usernames are normalized to lowercase.
  • Reserved route names such as docs, pricing, and faq are blocked.