Authorization

Connect

Webhooks

HealthAI

Assessment
EkaScribe

General Tools

Medical Document Parsing

Doctor Tool

Actors
Instructions
Patient Registration API
Doctor and clinic API
Appointment API
Payments API
Prescription API
Notify
Webhooks

ABDM Connect

Create and Login
User Session
Patient Requests
Consents
Care Contexts
Providers
Profile
Scan & Share
Errors

Medical Knowledge-bases

Overview
Protocols
Medications

Medical Records

Create
Read
Update
Delete
Webhooks

User App

Notifications
Vital
Webhooks
Privacy

Release Notes

ABDM Connect

Doctor and clinic API

Get Clinic details

Overview

This API endpoint retrieves detailed information about a specific clinic using its unique identifier.

Endpoint

URL: {{HOST}}/dr/v1/business/clinic/{{clinic_id}} Method: GET

Request Parameters

Parameter	Type	Description	Required
clinic_id	string	Unique identifier for the clinic	Yes

Response Parameters

Parameter	Type	Description
success	boolean	Indicates if the request was successful
data	object	Response data object
data.clinic	object	Clinic details
data.clinic.clinic_id	string	Unique identifier of the clinic
data.clinic.name	string	Name of the clinic
data.clinic.address	object	Address details of the clinic
data.clinic.address.city	string	City of the clinic
data.clinic.address.country	string	Country of the clinic
data.clinic.address.lat	string	Latitude of the clinic
data.clinic.address.line1	string	Address line 1
data.clinic.address.lon	string	Longitude of the clinic
data.clinic.address.pincode	string	Pincode of the clinic
data.clinic.address.state	string	State of the clinic

GET

business

clinic

{clinic_id}

curl --request GET \
  --url https://api.eka.care/dr/v1/business/clinic/{clinic_id} \
  --header 'auth: <auth>'

{
  "success": true,
  "data": {
    "clinic": {
      "clinic_id": "62e7929ab123a6001e80e833",
      "name": "DIABETES AND ENDOCRINE CLINIC",
      "address": {
        "city": "Bangalore",
        "country": "India",
        "lat": 20.1777602,
        "line1": "302, 3rd floor, RK",
        "lon": 71.8255817,
        "pincode": 560048,
        "state": "Karnataka"
      }
    }
  }
}

Headers

auth

string

required

The auth token of the business. It is used to authenticate the client. This should be fetched from auth API.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM"

Path Parameters

clinic_id

string

required

Unique identifier for the clinic

Example:

"62e7929ea968a6001e80e833"

Response

200

application/json

success

boolean

Example:

true

data

object

Get Doctor profile Getting started

curl --request GET \
  --url https://api.eka.care/dr/v1/business/clinic/{clinic_id} \
  --header 'auth: <auth>'

{
  "success": true,
  "data": {
    "clinic": {
      "clinic_id": "62e7929ab123a6001e80e833",
      "name": "DIABETES AND ENDOCRINE CLINIC",
      "address": {
        "city": "Bangalore",
        "country": "India",
        "lat": 20.1777602,
        "line1": "302, 3rd floor, RK",
        "lon": 71.8255817,
        "pincode": 560048,
        "state": "Karnataka"
      }
    }
  }
}