Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/bentlyy/Clinica/llms.txt

Use this file to discover all available pages before exploring further.

Two endpoints expose availability schedules. The public endpoint at /availability/:id accepts a doctor ID and requires no authentication, making it suitable for rendering a booking calendar before a user logs in. Authenticated doctors can also fetch their own schedule via /availability/me.

​
Endpoints

​
GET /api/availability/:id — public

Returns the full weekly availability schedule for a doctor. No authentication required. Path parameters
​
id
integer
required
ID of the doctor whose schedule you want to retrieve.

​
GET /api/availability/me — authenticated doctor

Returns the schedule for the currently authenticated doctor. Requires the doctor role. Headers
​
Authorization
string
required
Bearer token for a doctor account. Format: Bearer <token>

​
Response

Both endpoints return an array of availability records in the same shape.
​
id
integer
Unique availability record ID.
​
doctor_id
integer
ID of the owning doctor.
​
day_of_week
integer
Day of the week (0 = Sunday, 6 = Saturday).
​
start_time
string
Window start time (HH:MM).
​
end_time
string
Window end time (HH:MM).
curl --request GET \
  --url https://your-clinica-host/api/availability/3

[
  {
    "id": 5,
    "doctor_id": 3,
    "day_of_week": 1,
    "start_time": "09:00:00",
    "end_time": "17:00:00"
  },
  {
    "id": 6,
    "doctor_id": 3,
    "day_of_week": 3,
    "start_time": "09:00:00",
    "end_time": "13:00:00"
  }
]

Build docs developers (and LLMs) love

Get started for freeTalk to us