List Employees
list_employeesRetrieve employee summaries with optional filters for department, location, position, status, and dates. Returns code, name, and key details for quick reference.
Instructions
Get a list of employees in HR Partner with optional filters. Returns summary details per employee (code, name, department, location, position, status flags, dates). Use get_employee with the employee 'code' for full details including contacts, addresses and custom fields.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Only return employees who have this tag (single tag only) | |
| group | No | Only return records within this group (note: the field is always called 'group' in the API even if renamed to Branch/Entity etc. in the app) | |
| search | No | Return only employees whose first or last names match this search text | |
| location | No | One or more location names (separated by commas) to filter by | |
| position | No | Only return employees with this position description | |
| can_logon | No | Only return employees who can log on to their portal (true/false) | |
| is_active | No | Only return active employees (true/false) | |
| pay_point | No | Only return employees that have this pay point identifier | |
| department | No | One or more department names (separated by commas) to filter by | |
| reports_to | No | Only return employees who report to the employee with this Employee Code | |
| end_date_to | No | Return employees whose termination date is on/before this date (format yyyy-mm-dd) | |
| max_records | No | Optional client-side limit on the number of records returned. Use to keep responses small when exploring data; the API itself does not paginate. | |
| birth_date_to | No | Return employees whose birth date is on/before this date (format yyyy-mm-dd) | |
| end_date_from | No | Return employees whose termination date is on/after this date (format yyyy-mm-dd) | |
| is_terminated | No | Only return terminated employees (true/false) | |
| start_date_to | No | Return employees whose employment start date is on/before this date (format yyyy-mm-dd) | |
| birth_date_from | No | Return employees whose birth date is on/after this date (format yyyy-mm-dd) | |
| gender_identity | No | Only return employees with this gender (M/F or full extended identity string) | |
| start_date_from | No | Return employees whose employment start date is on/after this date (format yyyy-mm-dd) | |
| employment_status | No | Only return employees with this employment status | |
| eligible_for_rehire | No | Only return employees who are eligible for re-hiring (true/false) |