GET [ staff/{people_custom1} ]
Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/acu/staff/{people_custom1}
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/acu/staff/{people_custom1}
Overview
This endpoint returns the details of a single staff user from the current organisation (i.e. Enterprise Client account).
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 Staff Permission
The user has the same Organisation as the selected Staff user (id)
Please also refer to the Permissions Overview guide.
Query parameters
FIELD | TYPE | DESCRIPTION | Example | REQUIRED | DEFAULT | PATTERN |
|
| Custom String to differentiate between staff |
| YES |
|
|
Request Example
curl --location 'http://test.complyflow.com.au/app/public/index.php/api/acu/staff/PEOPLE_CUSTOM1' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]'
Response Example
The API Request returns the detail of a single staff from the current organisation.
{
"token": "",
"data": [
{
"id": 692,
"first_name": "wr",
"last_name": "er",
"dob": null,
"mobile": "0356133611",
"gender": "Male",
"indigenous_status": "",
"date_created": "2020-03-04 19:42:18",
"people_custom1": "shughi",
"address_street1": null,
"address_street2": null,
"address_suburb": null,
"address_region": null,
"postcode": null,
"address_country": 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,
"email": "cfdemo-sn-11231324@complyflow.com",
"training_courses": [
{
"id": 103,
"name": "Online Training B",
"status": "Completed",
"expiry_date": "2023-12-27",
"date_completed": "2023-12-22"
}
],
"staff_categories": [
{
"id": 148,
"name": "StaffA"
}
],
"hr_custom_fields": null,
"job_title": null,
"departments": null,
"account_status": "Request Pending",
"document_categories": [
{
"id": 163,
"name": "DocA",
"expiry_date": "2023-09-30"
}
],
"activation_deactivation_history": [
{
"action": "Activated",
"date": "2023-12-27",
"user": "Admin User"
},
{
"action": "Deactivated",
"date": "2024-06-15",
"user": "Admin User"
},
{
"action": "Activated",
"date": "2024-08-01",
"user": "Admin User"
}
]
}
]
}