Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Appointment API

Get Appointments

Overview

This API endpoint is used to retrieve all the appointments scheduled for a business with flexible filters.

Additional Information:

  • Valid filter combinations:
    1. patient_id (alone)
    2. doctor_id, start_date, end_date
    3. clinic_id, start_date, end_date
    4. start_date, end_date
    5. doctor_id, clinic_id, start_date, end_date
  • Dates must follow YYYY-MM-DD format.
  • The date range must not exceed 7 days.
  • end_date cannot be before start_date.
  • There is a limit i.e the maximum number of appointments returned per page. The value of limit is automatically set based on the filters used:
    • 20 → when filtering by patient_id (alone).
    • 50 → when filtering by (doctor_id, start_date, end_date) OR (clinic_id, start_date, end_date) OR (doctor_id, clinic_id, start_date, end_date).
    • 30 → when filtering only by (start_date, end_date).

Appointment_statuses:

  Booked / Queue States:
    - BK (Booked) : Appointment created/confirmed.
    - CK (Checked-in) : Booked appointment added to the Queue (Checked-in).
    - RV (Reserved) : Appointment marked as Reserved, when patient said they will come for the appointment on the follow-up appointment message.
    - IN (Initiated) : Appointment marked as Initiated, when patient received follow-up appointment message.
    - PA  (Parked) : Appointment moved to Parked state.

  Ongoing States:
    - OG (Ongoing): Consultation is in progress.

  Completion Statuses:
    - CM (Completed): Appointment completed with a prescription created.
    - CMNP (Completed No Prescription) : Appointment marked Exit from Queue / Completed without a prescription.
    - AB (Aborted) : Appointment was started (Start Visit) but not completed. Automatically marked AB at 12:00 AM next day.
    - NS (No Show) : Appointment was added to Queue but not started/completed. Automatically marked NS at 12:00 AM next day.
    - NSD (No Show Doctor) : No-show tagged specifically from a doctor’s action (if implemented).
    - NSS (No Show Staff) : No-show tagged specifically from a staff action (if implemented).

  Cancellation Statuses:
    - CN (Cancelled) : Appointment cancelled via API.
    - CND (Cancelled Doctor) : Cancelled from the doctor’s account in the tool.
    - CNS (Cancelled Staff) : Cancelled from the staff’s account in the tool.
    - PC (Provisional Cancelled) : Appointment marked as provisional cancellation, when patient said they will not come for the appointment on the follow-up appointment message.
    - PNR (Payment Not Received) : Appointment marked as PNR, when patient tried paying for a pre-paid appointment but the payment failed.

  Reschedule Statuses:
    - RE : Rescheduled via API.
    - RES : Rescheduled from staff account.
    - RED : Rescheduled from doctor account.
get/dr/v1/appointment

Query parameters

patient_idstring

Filter by patient. Cannot be combined with any other filter.

doctor_idstring

Filter by doctor (must be combined with start_date and end_date).

clinic_idstring

Filter by clinic (must be combined with start_date and end_date).

start_datestring date
Example:2025-05-01

Start date of appointments.

end_datestring date
Example:2025-05-07

End date of appointments.

page_nointeger

Page number for pagination (starts from 0).

  • Each page contains up to say 50 appointments (limit=50).
  • page_no=0 means the first page.
  • If the "appointments" array has exactly 50 items, there may be more results. Continue with page_no=1, page_no=2, etc.
  • If the "appointments" array has fewer than 50 items, there are no more results and you can stop fetching.

Headers

Authorizationstring required
Example:auth

Response

Successful response with appointment list

Example response

{
  "appointments": [
    {
      "status": "BK",
      "mode": "in_clinic"
    }
  ]
}