v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
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

ParameterTypeDescriptionRequired
clinic_idstringUnique identifier for the clinicYes

Response Parameters

ParameterTypeDescription
successbooleanIndicates if the request was successful
dataobjectResponse data object
data.clinicobjectClinic details
data.clinic.clinic_idstringUnique identifier of the clinic
data.clinic.namestringName of the clinic
data.clinic.addressobjectAddress details of the clinic
data.clinic.address.citystringCity of the clinic
data.clinic.address.countrystringCountry of the clinic
data.clinic.address.latstringLatitude of the clinic
data.clinic.address.line1stringAddress line 1
data.clinic.address.lonstringLongitude of the clinic
data.clinic.address.pincodestringPincode of the clinic
data.clinic.address.statestringState of the clinic
get/dr/v1/business/clinic/{clinic_id}

Path parameters

clinic_idstring required
Example:62e7929ea968a6001e80e833

Unique identifier for the clinic

Headers

authstring required
Example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM

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

Response

OK

successboolean

Example response

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