Skip to main content

GET /api/v1/users/nickname/available

Checks whether a given nickname is available for registration. Returns a boolean indicating availability.

Authentication​

Optional. No token required.

Request​

Query Parameters​

ParameterTypeRequiredDescription
nicknamestringYesThe nickname to check availability for

Example​

curl -X GET "https://intotes.com/api/v1/users/nickname/available?nickname=john_doe"

Response​

200 OK​

{
"available": true
}

Response Fields​

FieldTypeDescription
availablebooltrue if the nickname is available, false otherwise

Errors​

StatusCodeDescription
400missing_nicknameThe nickname query parameter is missing
400invalid_nicknameThe nickname format is invalid