smarthr_list_employees
List employees (従業員) of the SmartHR tenant, with filters: free-text name/department/position search, status (employed, absent, retired), employee number, employment type, department, position, hire and resignation date ranges. Returns a compact record per employee; use fields for more. Sensitive data (bank accounts, insurance numbers, residence cards, salary, ID images) is never returned.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Free-text search over name, business name, department name and position name. | |
| id | No | Employee id(s), comma separated. | |
| page | No | Page number, 1-based (default 1). Use next_page from the previous reply. | |
| sort | No | Sort order: property names, several separated by commas, a leading "-" means descending, e.g. "-updated_at". | |
| fields | No | Which employee fields to return (default: names, status, email, departments, positions, grade, job category, dates). Add address, tel_number, birth_at, custom_fields, contract_* and so on when needed. Bank, insurance, tax, salary and ID-document data are never available. | |
| user_id | No | User id(s), comma separated. | |
| emp_code | No | Exact employee number. | |
| per_page | No | Results per page, 1-100 (default 50). | |
| emp_status | No | Only employees with this status. | |
| position_id | No | Position id(s), comma separated (from smarthr_list_positions). | |
| department_id | No | Department id(s), comma separated (from smarthr_list_departments). | |
| entered_at_to | No | Hired on or before this day (yyyy-mm-dd). | |
| resigned_at_to | No | Resigned on or before this day (yyyy-mm-dd). | |
| entered_at_from | No | Hired on or after this day (yyyy-mm-dd). | |
| resigned_at_from | No | Resigned on or after this day (yyyy-mm-dd). | |
| employment_type_id | No | Employment type id(s), comma separated (from smarthr_list_employment_types). |