GET [ employee/{id} ]
Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/acu/employee/{id}
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/acu/employee/{id}
Overview
This endpoint returns the details of a single ‘employee’ user (i.e. a Worker) from a Contractor/Supplier Account associated with the current Enterprise Client organisation.
Authentication instructions
Refer to the Authentication method for Authentication Methods (for Login and Logout).
Permissions Required
The user should possess the permissions below:
API User
User is Staff
Users have View Employee Permission
The selected Employee exists in the User’s organization
Please also refer to the Permissions Overview guide.
Query parameters
FIELD | TYPE | DESCRIPTION | Example | REQUIRED | DEFAULT | PATTERN |
|
| Employee ID |
| YES |
|
|
Request Example
curl --location 'http://test.complyflow.com.au/app/public/index.php/api/acu/employee/3269' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]'
Response Example
The API Request returns the details of the user selected:
{
"token": "",
"data": [
{
"id": 3269,
"first_name": "lol",
"last_name": "lol",
"email": "shughi.test@gmail.com",
"contractor_id": 1554,
"company_name": "asda13123213",
"company_trade_name": "asda123123123123123",
"projects": [
"a"
],
"hr_custom_fields": null,
"departments": null,
"category_status": "Pending",
"attributes": [
{
"name": "PersonA",
"value": "No"
}
],
"invite_date": "2024-07-02 19:59:16",
"phone": "0356133611",
"photo_status": 0,
"indigenous_status": "",
"gender": "Female",
"address_street1": null,
"address_street2": null,
"address_suburb": null,
"address_state": null,
"address_country": "",
"postcode": null,
"emergency_contact_address_number": null,
"emergency_contact_address_street": null,
"emergency_contact_address_suburb": null,
"emergency_contact_address_state": null,
"emergency_contact_address_postcode": null,
"online_training": null,
"worker_categories": [
{
"id": 76,
"name": "WorkerCateB"
}
],
"documents": [
{
"id": 167,
"name": "DocB2",
"expiry": null,
"status": "Approved",
"filename": "mpdf.pdf",
"global_document": 0
}
],
"job_title": null,
"account_status": "Active",
"last_updated": "2024-07-03 13:12:50"
}
]
}
Photo status (photo_status); 0 - NOT_APPROVED; 1 – APPROVED