Appointments API Overview¶

The Appointments API provides endpoints to manage appointments, including creating, listing, updating, and canceling appointments. It also supports managing appointment categories and cancellation reasons.

Available Endpoints¶

Core Appointment Management¶

Create Appointment - Create a new appointment
List Appointments - Retrieve appointments with filtering options
Cancel Appointment - Cancel an appointment with reason and fee

Supporting Endpoints¶

Get Cancellation Reasons - Retrieve available cancellation reasons and fees
Get Appointment Categories - Retrieve appointment categories and types

API Reference¶

POST Endpoints¶

Create Appointment - POST /apis/v1/appointment
Create new appointment with patient, doctor, and clinic
Cancel Appointment - POST /apis/v1/appointment/appointment-cancel/{appointment_id}
Cancel existing appointment with reason and fee

GET Endpoints¶

List Appointments - GET /apis/v1/appointments
Retrieve paginated list of appointments with filters
Get Appointment Categories - GET /apis/v1/appointment/categories
Retrieve available appointment categories
Get Cancellation Reasons - GET /apis/v1/appointment/appointment-cancellation
Retrieve available cancellation reasons and associated fees

Response Format¶

All appointment API responses follow the standard format:

Success Response¶

{
  "code": 2000,
  "data": { ... },
  "message": "Success"
}

Error Response¶

{
  "code": 4001,
  "message": "Error description"
}

Patients Overview - Patient management
Doctors Overview - Doctor availability and scheduling
Clinics Overview - Clinic information and settings
Webhooks Overview - Appointment-related notifications