1. Knowledge Base
  2. API Documentation

[API Endpoint] Employees

Overview

This API endpoint will provide you a list of employees with basic information.

Endpoint

GET /OAuth2/employees/get_employees.php

Route

GET /OAuth2/employees/get_employees.php?api_key=your_api_key&company=company_id&section=staff

Parameters

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

Our API endpoint expects three parameters:

  • api_key(string)

  • company(int)

  • section(string)

All three fields are required in order to receive a successful response from our endpoint.

Sample Response

"id": "007",
"full_name": "James Bond",
"email": "james.bond@007.com",
"user_avatar": "/cdn/file_attachments/615/avatar_photos/BondPose.jpeg"