kiwihr_list_users
List employees
List or search employees (kiwiHR 'users') with name, work email, active flag, employee number, employment dates, position, team, location and manager. Filter by active state, team, location, position, e-mail or name. Payroll, bank, tax and insurance data are never included. GraphQL query users.
輸入參數emaillimitoffsetsort_byteam_iduser_idsis_activelast_namefirst_namelocation_idposition_idsort_direction另有 1 個
kiwihr_get_user
Get employee
One employee by id: the list fields plus probation end, about-me, language, invitation status, work phones, all teams, work schedule and custom field values. With include_personal=true it also returns birth date, private e-mail and phone, nationality, gender, pronouns, home address, emergency contact and custom fields of the personal sections. Payroll, bank (IBAN/BIC), tax and insurance data are never returned. GraphQL query user.
輸入參數user_id必填include_personal
kiwihr_list_teams
List teams
List teams and departments (id, name, kind GROUP or DEPARTMENT). Use the ids to filter employees. GraphQL query teams.
輸入參數limitoffsetsort_bysort_direction
kiwihr_list_locations
List locations
List office locations (id, name). Use the ids to filter employees. GraphQL query locations.
輸入參數limitoffsetsort_bysort_direction
kiwihr_list_positions
List positions
List job positions (id, name). Use the ids to filter employees. GraphQL query positions.
輸入參數limitoffsetsort_bysort_direction
kiwihr_list_custom_fields
List custom fields
List the company's custom employee profile fields (id, name, section, data type, choice options). Payroll and bank sections are listed by name only; their values are never returned by any tool. GraphQL query customFields.
輸入參數limitoffsetsort_bysort_direction
kiwihr_list_time_off_types
List time off types
List time off (absence) types such as vacation or sick leave: id, name, colour, visibility to team members. Use the ids with kiwihr_get_time_off_usage and kiwihr_list_time_off_balances. GraphQL query timeOffTypes.
輸入參數limitoffsetsort_bysort_direction
kiwihr_list_time_off_balances
List time off balances
Time off balances of all employees: per employee and time off rule the allowance, accrued, used, requested, planned and available days, carry-over and the accrual/usage periods. Filter by time off type, active state and usage period. The API has no per-employee filter or paging for this query; read the result per user. GraphQL query timeOffBalances.
輸入參數sort_byis_activesort_directiontime_off_type_idusage_period_end_tousage_period_start_from
kiwihr_get_time_off_usage
Get time off usage
Who took (or requested) how much time off in a date range: per employee the request count and used days for each time off rule of the chosen time off types. Use it for absence reports ('who was off in March?'). Optional employee filters as in kiwihr_list_users. GraphQL query timeOffRequestUsageStatements.
輸入參數limitoffsetdate_to必填sort_byteam_iddate_from必填is_activelocation_idsort_directiontime_off_type_ids必填
kiwihr_list_timesheets
List timesheets
Daily timesheets of one employee (or the key's admin user when user_id is omitted) in a date range: expected, tracked, time off, holiday and break time in SECONDS, approval flag, time offs, holidays, entries (start/end, type, note, project) and break-rule violations. GraphQL query timesheets.
輸入參數limitoffsetdate_to必填user_iddate_from必填
kiwihr_get_timesheet
Get timesheet
The timesheet of ONE employee for ONE day (user_id omitted = the admin user the key acts as), with all entries and their ids (needed to update or delete an entry). Times in seconds. GraphQL query timesheet.
輸入參數date必填user_id
kiwihr_get_attendance_statement
Get attendance statement
Attendance summary of ONE employee over a date range: expected, tracked, total, time off and holiday time (seconds) and days, balance, overtime, meal vouchers, and tracked time per project. GraphQL query attendanceStatement.
輸入參數date_to必填user_id必填date_from必填
kiwihr_list_attendance_statements
List attendance statements
Attendance summaries of ALL employees over a date range (expected vs tracked time, time off, holidays, balance, overtime, tracked time per project). Optionally only employees with time tracked on a project, or with uncategorized time; inactive employees can be included. GraphQL query attendanceStatements.
輸入參數date_to必填sort_bydate_from必填project_idsort_directionhas_uncategorized_timeinclude_inactive_users
kiwihr_list_overtime_balances
List overtime balances
Current overtime balance (seconds) per employee. GraphQL query overtimeBalanceStatements.
輸入參數limitoffsetsort_bysort_direction
kiwihr_list_projects
List projects
List time-tracking projects (id, name, status ACTIVE or INACTIVE). GraphQL query projects.
輸入參數limitoffsetstatussort_bysort_direction
kiwihr_get_project
Get project
One time-tracking project by id (name, status). GraphQL query project.
輸入參數project_id必填
kiwihr_list_journeys
List journeys
List onboarding/offboarding journeys (id, name, status DRAFT/ONGOING/COMPLETED/CANCELLED, assignee, journey type, custom date). Filter by status, assignee, type or team. GraphQL query journeys.
輸入參數limitoffsetstatusteam_idsassignee_idsjourney_type_ids
kiwihr_get_journey
Get journey
One journey by id with its steps (name, description, fixed start and due dates). With include_personal=true it also returns the private e-mail address stored on the journey. GraphQL query journey.
輸入參數journey_id必填include_personal
kiwihr_list_journey_templates
List journey templates
List journey templates (id, name, description, type). Use a template id with kiwihr_create_journey. GraphQL query journeyTemplates.
輸入參數limitoffsetjourney_type_id
kiwihr_list_journey_types
List journey types
List journey types such as pre-onboarding, onboarding or offboarding (id, name, key, archived date). GraphQL query journeyTypes.
輸入參數limitoffset
kiwihr_create_timesheet_entry
Create timesheet entry
WRITE: add a time entry to the timesheet of one employee on one day (user_id omitted = the admin user the key acts as). type MANUAL = worked time (give start_at and end_at as HH:mm:ss, or a part_of_day), BREAK = a break. Optional project and note. Creates a new entry each call (not idempotent). Returns the updated day. GraphQL mutation createTimesheetEntry.
輸入參數date必填notetype必填end_atuser_idstart_atproject_idpart_of_day
kiwihr_update_timesheet_entry
Update timesheet entry
WRITE: change an existing timesheet entry (get its id from kiwihr_get_timesheet): times, part of day, project or note. Only the fields you pass are changed. Setting the same values again gives the same result. Returns the updated day. GraphQL mutation updateTimesheetEntry.
輸入參數noteend_atentry_id必填start_atproject_idpart_of_day
kiwihr_delete_timesheet_entry
Delete timesheet entry
WRITE, DESTRUCTIVE: permanently delete one timesheet entry by id (get it from kiwihr_get_timesheet). This cannot be undone. Returns true when deleted. GraphQL mutation deleteTimesheetEntry.
輸入參數entry_id必填
kiwihr_create_project
Create project
WRITE: create a time-tracking project (name, status ACTIVE or INACTIVE; default ACTIVE). Creates a new project each call (not idempotent). GraphQL mutation createProject.
輸入參數name必填status
kiwihr_update_project
Update project
WRITE: rename a project or switch it ACTIVE/INACTIVE (INACTIVE projects can no longer be used for time tracking). Only the fields you pass are changed. GraphQL mutation updateProject.
輸入參數namestatusproject_id必填
kiwihr_create_user
Create employee
WRITE: add a new employee record (first name, last name and work e-mail are required; optional start date, manager, teams, position, location and phones). Creates a new employee each call (not idempotent). No invitation is sent by this tool. Payroll and bank data cannot be set. GraphQL mutation createUser.
輸入參數email必填genderteam_idslast_name必填first_name必填manager_idlocation_idposition_idwork_phonesemployment_start_date
kiwihr_update_user
Update employee
WRITE: change an employee's work profile: name, start date, about-me, work phones, position, team(s), location, manager. Only the fields you pass are changed (team_ids replaces the whole team list). Private, payroll and bank data cannot be changed with this tool. GraphQL mutation updateUser.
輸入參數user_id必填about_meteam_idslast_namefirst_namemanager_idlocation_idposition_idwork_phonesemployment_start_date
kiwihr_deactivate_user
Deactivate employee
WRITE, ACCESS-CHANGING: deactivate an active employee (typically after they leave): they lose access to kiwiHR and drop out of active lists. Reversible with kiwihr_activate_user. GraphQL mutation deactivateUser.
輸入參數user_id必填
kiwihr_activate_user
Activate employee
WRITE: re-activate a deactivated employee so they appear in active lists and can use kiwiHR again. GraphQL mutation activateUser.
輸入參數user_id必填
kiwihr_create_journey
Create journey
WRITE: create an onboarding/offboarding journey for an employee from a journey type and optionally a template (ids from kiwihr_list_journey_types / kiwihr_list_journey_templates). Creates a new journey each call (not idempotent). It does not publish it; check the status in the reply. GraphQL mutation createJourney.
輸入參數nameassignee_id必填custom_datepersonal_emailjourney_type_id必填custom_date_namejourney_template_idpre_onboarding_access