API reference

Account & clinic

Work with any valid key, whatever its scopes. Call /auth/me first to check the key works and see who it belongs to.

Who am I

GET/api/v1/auth/meAny valid key

The person and clinic the key acts for. A great first call to test a new key.

Example request

bash

curl "https://your-healthfix-site/api/v1/auth/me" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response

json

{ "data": { "id": "…", "full_name": "Riya Front", "role": "receptionist", "clinic_id": "…", "clinic_name": "City Heart Clinic", "…": "…" } }

Clinic profile

GET/api/v1/clinicAny valid key

Name, address, phone, city and patient ID prefix.

Example request

bash

curl "https://your-healthfix-site/api/v1/clinic" \
  -H "Authorization: Bearer YOUR_API_KEY"

Clinic settings

GET/api/v1/clinic/preferencesAny valid key

Time zone, currency, country and tax label. Use the time zone when showing or sending times.

Example request

bash

curl "https://your-healthfix-site/api/v1/clinic/preferences" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response

json

{ "data": { "currency": "INR", "timezone": "Asia/Kolkata", "country_code": "IN", "tax_label": "GST", "tax_id": null, "invoice_prefix": "INV", "invoice_footer": "" } }