smarthr_list_employees
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.
Parametersqidpagesortfieldsuser_idemp_codeper_pageemp_statusposition_iddepartment_identered_at_to+4 more
smarthr_get_employee
Get an employee
Get one employee (従業員) by id. Returns a compact record; use `fields` for more (address, phone, birth date, custom fields, contract dates). Sensitive data is never returned.
Parametersidrequiredfields
smarthr_list_dependents
List an employee's dependents
List the dependents (家族情報) registered for one employee: name, relation, birth date, living arrangement and support status. Pension numbers, income and documents are not returned.
Parameterspageper_pageemployee_idrequired
smarthr_list_maternity_childcare_leaves
List an employee's maternity and childcare leaves
List the maternity and childcare leave records (産休育休) of one employee: expected birth, leave start/end and scheduled return dates. Bank, insurance and memo data are not returned.
Parameterspageper_pageemployee_idrequired
smarthr_list_departments
List departments
List departments (部署) with their hierarchy (parent, children), code and company.
Parameterscodepagesortper_page
smarthr_get_department
Get a department
Get one department (部署) by id, with its parent and children.
Parametersidrequired
smarthr_list_positions
List positions
List positions / job titles (役職) with their rank and code.
Parameterspagesortper_page
smarthr_list_employment_types
List employment types
List employment types (雇用形態), e.g. full-timer, part-timer, contract worker, with their ids for filtering and writes.
Parameterspageper_page
smarthr_list_grades
List grades
List grades (等級) with their rank.
Parameterspageper_page
smarthr_list_job_categories
List job categories
List job categories (職種).
Parameterspageper_page
smarthr_list_companies
List companies
List the companies (会社) of the tenant: name, code, corporate number, address, phone.
Parameterspageper_page
smarthr_list_business_establishments
List business establishments
List business establishments (事業所): name, social insurance and labor insurance registration data, company.
Parameterspageembedper_page
smarthr_list_employee_custom_fields
List employee custom field definitions
List the definitions of the tenant's custom employee fields (カスタム従業員項目): name, type and, for dropdowns, the choices. Use them to read the values in custom_fields.
Parameterspageembedper_page
smarthr_list_dependent_relations
List dependent relations
List the relation types for dependents (続柄: spouse, child, parent...) with their ids, needed by smarthr_create_dependent.
Parameterspageper_page
smarthr_list_users
List users
List SmartHR users (login accounts): email, administrator flag, role, linked employee, and the invitation status (created, opened, accepted, answered). Use it to find the administrator id for smarthr_invite_employee.
Parameterspagesortembedper_page
smarthr_list_employee_input_forms
List employee input forms
List the employee information collection forms (従業員情報収集フォーム) that an invitation can use.
Parameterspageper_page
smarthr_list_webhooks
List webhooks
List the configured webhooks (target URL, which employee and dependent events notify). Read-only; secret tokens and the query string of the target URL are never shown.
Parameterspageper_page
smarthr_create_employee
Create an employee
WRITE: Register a new employee (従業員) in SmartHR. Nothing is sent to the employee; to invite them to fill in their own data use smarthr_invite_employee afterwards. Only the fields you give are set. The tenant plan may cap the number of employees (error plan_limit_exceeded). Returns the created employee as a compact record.
Parametersemailgradegenderaddressbirth_atemp_codelast_namerequiredpositionsemp_statusentered_atfirst_namerequiredoccupation+11 more
smarthr_update_employee
Update an employee
WRITE: Change fields of one existing employee (partial update: only the fields you give change; others stay). Typical uses: set the status to absent or retired with the resignation date, correct a name, email or phone, move the employee to other departments (department_ids replaces the current list), change positions. SmartHR does not allow clearing a name that is already filled in. Returns the updated employee as a compact record.
Parametersidrequiredemailgradegenderaddressbirth_atemp_codelast_namepositionsemp_statusentered_atfirst_name+12 more
smarthr_create_department
Create a department
WRITE: Create a department (部署). Give the parent department id to nest it. Returns the created department.
Parameterscodenamerequiredpositionparent_idcompany_id
smarthr_update_department
Update a department
WRITE: Rename or move one department (partial update: only the fields you give change). Returns the updated department.
Parametersidrequiredcodenamepositionparent_id
smarthr_create_dependent
Create a dependent
WRITE: Register a dependent (家族情報) for an employee. Needs the relation id from smarthr_list_dependent_relations. Returns the created dependent without pension number, income or documents.
Parametersjobgenderrequiredaddressbirth_atrequiredis_spouselast_namerequiredfirst_namerequiredtel_numberemployee_idrequiredrelation_idrequiredlast_name_yomifirst_name_yomi+3 more
smarthr_invite_employee
Invite an employee by email
WRITE, SENDS AN EMAIL: Invite an employee to SmartHR. SmartHR emails the address stored on the employee (the employee must have one) an invitation to create their login and, with an input form, to fill in their own data. Asking again re-sends it (and updates the invited address if it changed). An employee who already accepted cannot be invited again. Confirm with the user before calling.
Parametersidrequiredinviter_user_idrequiredcrew_input_form_id
