Skip to main content
GET
Check Username Availability
Checks whether the specified username is already in use within the project. Returns a simple availability flag. Use this before prompting users to set a username to give instant feedback.

Query Parameters

username
string
required
The username to check. Lookup is exact-match against the stored (lowercased) value.

Response

On success, returns HTTP 200 with:
available
boolean
true if the username is not yet taken; false if it is already in use.
Example — available:
Example — taken:

Error Responses

See Also