API EndpointsUsersCheck Username Availability

Check Username Availability

Endpoint

URL: /:projectId/users/check-username

Method: GET

Authentication Required: No


Description

Check if a given username is available for use.


Request

Query Parameters

ParameterTypeRequiredDescription
usernamestringYesThe username to check for availability.

Headers

None

Body Parameters

None

Example Request

GET /proj1234/users/check-username?username=johndoe

Response

Success Response (200 OK)

Username Available

{
  "available": true
}

Username Taken

{
  "available": false
}

Error Responses

Missing or Invalid Username (400 Bad Request)

{
  "error": "Username is required and must be a string.",
  "code": "username/invalid-input"
}

Server Error (500 Internal Server Error)

{
  "error": "An error occurred while checking username availability.",
  "code": "username/server-error",
  "details": "<Error message>"
}

Notes

  • This endpoint does not require authentication.
  • Only exact matches are considered (case-sensitive).