1. Knowledge Base
  2. API Documentation

[API Endpoint] Get Clients

Overview

This API endpoint allows you to obtain a list of clients from your PabauCRM clinic.

Endpoint

GET /OAuth2/clients/get_clients.php

Route

GET /OAuth2/clients/get_clients.php?api_key=your_api_key&company=your_company_id&section=contacts

Parameters

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

Our API endpoint expects three parameters:

  • api_key(string)

  • company(int)

  • section(string)

Sample Response

{
  "success": true,
  "total": 2020,
  "contacts": [{...}]
}