Skip to content
  • There are no suggestions because the search field is empty.

How to Access the Pabau API Documentation

In this article, we’ll show you how to access and use the official Pabau API documentation.

If you’re looking to integrate Pabau with other platforms, automate workflows, or build custom solutions, our API allows you to do just that — securely and efficiently.

To simplify access, all API-related guides and documentation have now been consolidated into one central hub. Instead of multiple articles, you can now find everything you need in a single, easy-to-navigate reference.

To explore the complete list of available endpoints, authentication methods, and usage examples, visit the official Pabau API documentation page below:

🔗 Access the Pabau API Documentation

Inside the documentation, you’ll find:

  • 🔹 Complete API endpoint references

  • 🔹 Authentication setup instructions

  • 🔹 Example requests and responses

  • 🔹 Usage limits, rules, and best practices

Can the API Return Free Slots and Treatment Notes?

Yes. Both are in the documentation linked above:

  • Free appointment slots: under Appointments, use List Available Time Slots (GET /appointments/slots). You must pass service_ids; you can also pass employee_ids and location_id. Set date to a single day (YYYY-MM-DD), a month (MM/YYYY) or a range such as next7 (the default), week-next or month-this. The response lists each date with the free times for each employee.
  • Treatment notes: treatment notes are client forms of the treatment type. Under EMR → Client Forms, use List Client Forms (GET /clients/{client_id}/medical-forms) and add form_type=treatment to return only treatment forms and their content. Free-text notes on the client record are returned by List Client Notes (GET /clients/{contact_id}/notes).

NOTE: form_type also accepts consent, questionnaire, prescription and epaper, and you can combine types with commas, for example form_type=treatment,consent. Your API key needs access to client records to read forms and notes.

Can the API mark a lead won, move it to another stage, or create pipelines?

  • Mark a lead won, lost or reopened: yes – POST /leads/{id}/win, POST /leads/{id}/lost or POST /leads/{id}/reopen. Pass the user_id of the staff member the change is recorded against.
  • Move a lead to another stage: yes – update the lead with POST /leads/{id}/update and send the new pipeline_stage_id. The stage must already exist in your account, otherwise the request is rejected.
  • See your pipelines and stages: GET /leads/pipelines returns them, so you can look up the stage IDs to use.
  • Create pipelines: no – the API has no endpoint for creating pipelines or stages. Set them up in Pabau first, then reference their IDs from your system.

NOTE: Your API key needs access to leads for these requests. Check the documentation linked above for the full request and response format.



Was this guide helpful? Let us know by voting below - your feedback helps us write clearer articles.

For more guides, browse the related articles below or use the search bar at the top of the page. You can also watch our video learning series, the Pabau Academy, or visit the Support page for additional help.