Skip to main content
GET
/
:projectId
/
api
/
v7
/
users
/
check-username
Check Username Availability
curl --request GET \
  --url https://api.replyke.com/api/v6/:projectId/api/v7/users/check-username
{
  "available": true
}
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: 
{ "available": true }
Example — taken: 
{ "available": false }

​
Error Responses

{
  "error": "...",
  "code": "username/invalid-query"
}

​
See Also