Skip to main content

Pabau Public Developer API Documentation

Welcome to the documentation for the Pabau Public Developer API! This documentation provides detailed information about using the API to interact with Pabau, a platform for managing medical practices and patient records. The Pabau Public Developer API allows developers to integrate their applications with Pabau, enabling them to access and manipulate data related to patients, appointments, treatments, and more.

Table of Contents​

  1. Introduction
  2. Authentication
  3. Endpoints
  4. Error Handling
  5. Rate Limiting
  6. Conclusion

Introduction​

The Pabau Public Developer API provides a RESTful interface for interacting with Pabau's core features. With this API, you can create, retrieve, update, and delete data related to patients, appointments, treatments, and invoices.

To get started, you'll need an API key. Please contact Pabau support to obtain your API key and ensure that you have the necessary permissions to access the desired resources.

Base URL: https://api.pabau.com

Authentication​

All API requests must be authenticated using an API key. Include your API key in the Authorization header of each request:

Authorization: Bearer YOUR_API_KEY

Endpoints​

Patients​

Retrieve a Patient​

GET /patients/{patient_id}

Retrieve the details of a specific patient by their patient_id.

Create a Patient​

POST /patients

Create a new patient with the provided details. The request body should contain the necessary fields for creating a patient.

Update a Patient​

PATCH /patients/{patient_id}

Update the details of an existing patient specified by their patient_id. The request body should contain the fields to be updated.

Delete a Patient​

DELETE /patients/{patient_id}

Delete a patient specified by their patient_id.

Appointments​

Retrieve an Appointment​

GET /appointments/{appointment_id}

Retrieve the details of a specific appointment by its appointment_id.

Create an Appointment​

POST /appointments

Create a new appointment with the provided details. The request body should contain the necessary fields for creating an appointment.

Update an Appointment​

PATCH /appointments/{appointment_id}

Update the details of an existing appointment specified by its appointment_id. The request body should contain the fields to be updated.

Delete an Appointment​

DELETE /appointments/{appointment_id}

Delete an appointment specified by its appointment_id.

Treatments​

Retrieve a Treatment​

GET /treatments/{treatment_id}

Retrieve the details of a specific treatment by its treatment_id.

Create a Treatment​

POST /treatments

Create a new treatment with the provided details. The request body should contain the necessary fields for creating a treatment.

Update a Treatment​

PATCH /treatments/{treatment_id}

Update the details of an existing treatment specified by its treatment_id. The request body should contain the fields to be updated.

Delete a Treatment​

DELETE /treatments/{treatment_id}

Delete a treatment specified by its treatment_id.

Invoices​

Retrieve an Invoice​

GET /invoices/{invoice