Get
/api/v1/users.checkUsernameAvailability
Header parameters
X-Auth-Token
stringRequired
The authenticated user token.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The authenticated user ID.
ExamplerbAXPnMktTFbNpwtJ
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"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string