Overview

This API endpoint allows you to obtain a list of appointments from Pabau.

Depending on what you require:

  • You can request to retrieve data specifically to one appointment, by appointment_id

  • You can request to retrieve data specifically to one date, by date(Y-m-d)

  • Or if no appointment_id, or date parameter provided, you will get a list of todays appointment for your clinic.

Endpoint

GET /OAuth2/appointments/get_appointments.php

Route for single appointment

GET /OAuth2/appointments/get_appointments.php?api_key=your_api_key&company=your_company_id&section=bookings&appointment_id=desired_appointment_id

* You can get a single appointment_id by getting a list of todays appointments,or specific date

Route for appointments by date

GET /OAuth2/appointments/get_appointments.php?api_key=your_api_key&company=your_company_id&section=bookings&date=2020-05-08

Route for todays appointments

GET /OAuth2/appointments/get_appointments.php?api_key=your_api_key&company=your_company_id&section=bookings


Below are a list of the attributes you can currently pass into Pabau.

Our API endpoint accepts these 4 parameters:

  • api_key(string)

  • company(int)

  • section(string)

  • date(string) - *formatted as Y-m-d

  • appointment_id(int)

Sample Response

{
  "total": 2,
  "appointments": [{...}],
  "success": true
}
Did this answer your question?