Outbound API documentation

Authentication

Every request is authenticated by a per-organization API key, sent as the X-Api-Key header (or an api_key query parameter, if your tool can’t set custom headers). The key scopes every response to that one clinic organization automatically — there is no way to read another organization’s data with a valid key.

Generate a key from inside HomeoAxis: Leads → Connect → Integrations → Outbound API Keys. Each key is shown once at creation time and stored hashed — keep it somewhere safe, since it can’t be retrieved again (only revoked and replaced).

curl https://homeoaxis.com/api/v1/integration/leads \
  -H "X-Api-Key: your_api_key_here"

Rate limit: 60 requests/minute per key. All endpoints are read-only (GET).

GET /api/v1/integration/leads

New enquiries captured by the clinic — website forms, ad webhooks, walk-ins, phone calls.

Query parameters

Response fields (per lead)

Example response

{
  "success": true,
  "message": "Success",
  "data": [
    {
      "id": 4021,
      "name": "Anita Sharma",
      "phone": "9876543210",
      "email": "anita@example.com",
      "problem": "Chronic migraine",
      "source": "google",
      "status": "new",
      "clinic_name": "Dr. Deepika's Homeopathy - Sector 62",
      "consultation_mode": "in_person",
      "preferred_date": "2026-09-20",
      "preferred_time": "17:30",
      "created_at": "2026-09-14T09:12:03+00:00"
    }
  ],
  "meta": { "current_page": 1, "last_page": 3, "per_page": 50, "total": 128 }
}

GET /api/v1/integration/patients

Patient records, enriched with billing and visit summary fields useful for outbound automation (payment reminders, recall campaigns).

Query parameters

Response fields (per patient)

Errors