Check Username Availability

Prev Next
Get
/api/v1/users.checkUsernameAvailability

Check if the username is available or used by another user

Header parameters
X-Auth-Token
stringRequired

The authenticated user token.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The authenticated user ID.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
username
stringRequired

The username to check for availability

ExamplejohnDoe
Responses
200

OK

Example 1
{
  "result": true,
  "success": true
}
Example 2
{
  "result": false,
  "success": true
}
object
result
boolean
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'username' [invalid-params]",
  "errorType": "invalid-params"
}
Example 2
{
  "success": false,
  "error": "system is blocked and can't be used! [error-blocked-username]",
  "errorType": "error-blocked-username",
  "details": {
    "method": "checkUsernameAvailability",
    "field": "system"
  }
}
Expand All
object
success
boolean
error
string
errorType
string
details
object
method
string
field
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string