List Doctors
Retrieve a paginated list of doctors for a specific clinic.
Endpoint
Parameters
Query Parameters
| Parameter |
Type |
Required |
Default |
Description |
clinicId |
string |
Yes |
- |
Comma-separated list of clinic IDs (e.g., "44,58,123") |
size |
integer |
No |
10 |
Number of records per page |
page |
integer |
No |
1 |
Page number for pagination |
| Parameter |
Type |
Required |
Description |
Authorization |
string |
Yes |
Bearer token for authentication |
Request
curl '{base_url}/v1/doctor?clinicId=44,58,123,399,503,634,642,717,802,805&size=50&page=2' \
-H 'accept: application/json, text/plain, */*' \
-H 'authorization: Bearer YOUR_TOKEN'
Response
Success Response
Code: 200 OK
{
"code": 2000,
"data": {
"total": 8,
"pages": 1,
"current": 1,
"no_of_records": 8,
"doctors": [
{
"doctor_id": 485195,
"first_name": "Matt",
"middle_name": null,
"last_name": "Swift",
"sex": "MALE",
"photo_url": "https://us-phy-uploads.s3.us-west-2.amazonaws.com/files/200e1bd5-e9b7-4988-b1d1-cc20324e2726.png",
"about": "Matt has been serving Orange County patients since 2006.",
"qualifications": [
"PT",
"DPT"
],
"services": [],
"sub_specializations": [],
"master_specialization": "PHYSICAL_THERAPIST",
"experiences": [],
"specialities": [],
"awards": null,
"registration_number": null,
"registration_body": null,
"languages": [
"ENGLISH"
],
"years_of_experience": 0,
"color_code": "#0a76db",
"secondary_color": null,
"text_color": null,
"license": "33345",
"roles": [
"ADMIN",
"DOCTOR"
],
"accomplishments": [],
"hobbies": [],
"clinics": [],
"doctor_rank": 0,
"doctor_designation_details": "License # 33345 (Initiated by Matt Swift, PT, DPT )",
"doctor_type": "HOME_DOCTOR",
"name": "Matt Swift"
}
]
}
}
Response Schema
Data Object
| Field |
Type |
Description |
total |
integer |
Total number of doctors |
pages |
integer |
Total number of pages |
current |
integer |
Current page number |
no_of_records |
integer |
Number of records in current response |
doctors |
array |
Array of doctor objects |
Doctor Object
| Field |
Type |
Description |
doctor_id |
integer |
Unique identifier for the doctor |
first_name |
string |
Doctor's first name |
middle_name |
string |
Doctor's middle name |
last_name |
string |
Doctor's last name |
name |
string |
Full name of the doctor |
sex |
string |
Gender (MALE, FEMALE, OTHER) |
photo_url |
string |
URL to doctor's profile photo |
about |
string |
Description about the doctor |
qualifications |
array |
List of professional qualifications |
services |
array |
List of services offered |
sub_specializations |
array |
List of subspecializations |
master_specialization |
string |
Primary specialization |
experiences |
array |
Work experience details |
specialities |
array |
Medical specialties |
awards |
string |
Awards and recognitions |
registration_number |
string |
Professional registration number |
registration_body |
string |
Registration authority |
languages |
array |
Languages spoken |
years_of_experience |
integer |
Total years of experience |
color_code |
string |
Primary color code for UI |
secondary_color |
string |
Secondary color code |
text_color |
string |
Text color code |
license |
string |
Medical license number |
roles |
array |
System roles (ADMIN, DOCTOR, etc.) |
accomplishments |
array |
List of accomplishments |
hobbies |
array |
Personal hobbies and interests |
clinics |
array |
Associated clinics |
doctor_rank |
integer |
Ranking within the system |
doctor_designation_details |
string |
Full designation details |
doctor_type |
string |
Type of doctor (HOME_DOCTOR, etc.) |