Docs
API ReferenceapiidentityGET /v1/users/handle-available

GET /v1/users/handle-available

Service: identity · operationId: (none)

Check whether a handle is available

Required scopes

(no scope declared — review service config)

Query parameters

  • handle (string) required —

Responses

200 Availability check result

{
  "type": "object",
  "properties": {
    "available": {
      "type": "boolean"
    }
  },
  "required": [
    "available"
  ]
}

500 Internal server error

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X GET https://identity.platform.loop.health/v1/users/handle-available \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Related

GET /v1/users/by-handle/{handle}GET /v1/users/me