Developer Platform

API Reference

Integrate Halkyone endpoints directly into custom applications, scheduling orchestrators, and analytics pipelines.

API Endpoints

POST/api/auth/magic-link

Request Passwordless Login

Generates a single-use secure login token and dispatches it via SMS/email channel to the clinician or practitioner device.

Request Parameters

email(string)Required

Primary practitioner email registered under the tenant.

deviceId(string)

Unique hardware ID of the mobile device to verify secure trust binding.

curl -X POST https://api.halkyone.health/api/auth/magic-link \
  -H "Content-Type: application/json" \
  -d '{"email": "practitioner@halkyone.health", "deviceId": "hw-2983x"}'
Response Payload (200 OK)
{
  "success": true,
  "message": "Magic link dispatched successfully",
  "expiresIn": 900
}