GET
/
dr
/
v1
/
appointment
/
{appointment_id}
curl --request GET \
  --url https://api.eka.care/dr/v1/appointment/{appointment_id} \
  --header 'auth: <auth>'
{
  "appointment_id": "{{eka_appointment_id}}",
  "partner_appointment_id": "{{partner_appointment_id}}",
  "created_at": 1730189586,
  "doctor_id": "{{doctor_id}}",
  "clinic_id": "{{clinic_id}}",
  "patient_id": "{{patient_id}}",
  "partner_doctor_id": "{{partner_doctor_id}}",
  "partner_clinic_id": "{{partner_clinic_id}}",
  "partner_patient_id": "{{partner_patient_id}}",
  "status": "CM",
  "mode": "in_clinic",
  "start_time": 1730189586,
  "end_time": 1730189586,
  "payment": {
    "payment_id": null,
    "payment_status": null,
    "amount": null
  },
  "prescription_id": "{{prescription_id}}",
  "service": {
    "created_at": 1730189586,
    "mode": [
      "INCLINIC"
    ],
    "price": null,
    "post_pay": false,
    "service_name": "consultation",
    "appointment_type": "REGULAR",
    "allow_patient_booking": true
  },
  "prescription_url": "https://prescription-store-s3.eka.care/P-DW-1234.pdf",
  "custom_attributes": {
    "label": [
      "vitals_submitted"
    ]
  },
  "video_connect": {
    "platform": "eka",
    "url": "https://mweb.eka.care/app/visit/start-call/{appointment_id}"
  },
  "partner_meta": {
    "key1": "value1"
  }
}

Headers

​
auth
string
required
Example:

"auth"

Path Parameters

​
appointment_id
string
required

Query Parameters

​
partner_id
string

If set to 1 then appointment_id in path parameter should be partner_appointment_id else eka apppointment_id

Example:

"1"

Response

200
application/json
OK
​
appointment_id
string
​
created_at
integer
​
doctor_id
string
​
patient_id
string
​
clinic_id
string
​
channel
string
​
status
enum<string>
Available options:
BK,
OG,
CM,
CMNP,
CN,
CND,
CNS
Example:

"BK"

​
mode
enum<string>
Available options:
tele,
in_clinic
Example:

"in_clinic"

​
start_time
integer
​
end_time
integer
​
payment
object
​
prescription_id
string
​
service
object
​
prescription_url
string
​
custom_attributes
object
​
video_connect
object
​
partner_meta
object