kiwiHR MCP by usefulapi
Read kiwiHR employees, time off, timesheets, projects; create and update employees, timesheets.
Should I use this
Quality & Safety
Findings (2)
- LOWTool 'kiwihr_get_attendance_statement' name length outside 3-30 rangein kiwihr_get_attendance_statement
- LOWTool 'kiwihr_list_attendance_statements' name length outside 3-30 rangein kiwihr_list_attendance_statements
Based on automated analysis of tool definitions and protocol compliance.
Context Cost
This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.
Install
One-Click Install
Add this to your `claude_desktop_config.json` file:
{
"mcpServers": {
"kiwihr": {
"url": "https://kiwihr.usefulapi.io/mcp"
}
}
}Remote endpoints
https://kiwihr.usefulapi.io/mcpstreamable-httpWhat it can do
Tool inventory
Tools (30)
🟢kiwihr_list_users(is_active, team_id, location_id, position_id, user_ids, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"is_active": {
"description": "true = active employees only, false = deactivated only. Omit for both.",
"type": "boolean"
},
"team_id": {
"description": "Team id (from kiwihr_list_teams).",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"location_id": {
"description": "Location id (from kiwihr_list_locations).",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"position_id": {
"description": "Position id (from kiwihr_list_positions).",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"user_ids": {
"description": "Only these employee ids.",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"email": {
"description": "Work e-mail contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"first_name": {
"description": "First name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"last_name": {
"description": "Last name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"employment_start_from": {
"description": "Only employees who started on or after this date.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"sort_by": {
"description": "Sort field.",
"type": "string",
"enum": [
"id",
"firstName",
"lastName",
"position",
"team",
"location"
]
},
"sort_direction": {
"description": "Sort direction (default ASC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_get_user(user_id, include_personal)
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.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Employee id."
},
"include_personal": {
"description": "Also return private data (birth date, private contact data, address, emergency contact). Default false.",
"type": "boolean"
}
},
"required": [
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_teams(sort_by, sort_direction, offset, limit)
List teams and departments (id, name, kind GROUP or DEPARTMENT). Use the ids to filter employees. GraphQL query teams.
Input Schema
{
"type": "object",
"properties": {
"sort_by": {
"type": "string",
"enum": [
"id",
"name"
]
},
"sort_direction": {
"description": "Sort direction (default ASC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_locations(sort_by, sort_direction, offset, limit)
List office locations (id, name). Use the ids to filter employees. GraphQL query locations.
Input Schema
{
"type": "object",
"properties": {
"sort_by": {
"type": "string",
"enum": [
"id",
"name"
]
},
"sort_direction": {
"description": "Sort direction (default ASC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_positions(sort_by, sort_direction, offset, limit)
List job positions (id, name). Use the ids to filter employees. GraphQL query positions.
Input Schema
{
"type": "object",
"properties": {
"sort_by": {
"type": "string",
"enum": [
"id",
"name"
]
},
"sort_direction": {
"description": "Sort direction (default ASC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_custom_fields(sort_by, sort_direction, offset, limit)
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.
Input Schema
{
"type": "object",
"properties": {
"sort_by": {
"type": "string",
"enum": [
"id",
"name",
"section",
"type"
]
},
"sort_direction": {
"description": "Sort direction (default ASC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_time_off_types(sort_by, sort_direction, offset, limit)
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.
Input Schema
{
"type": "object",
"properties": {
"sort_by": {
"type": "string",
"enum": [
"id",
"name"
]
},
"sort_direction": {
"description": "Sort direction (default ASC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_time_off_balances(time_off_type_id, is_active, usage_period_start_from, usage_period_end_to, sort_by, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"time_off_type_id": {
"description": "Only this time off type (from kiwihr_list_time_off_types).",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"is_active": {
"description": "true = active balances only.",
"type": "boolean"
},
"usage_period_start_from": {
"description": "Usage period starts on or after this date.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"usage_period_end_to": {
"description": "Usage period ends on or before this date.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"sort_by": {
"type": "string",
"enum": [
"periodStartDate",
"periodEndDate"
]
},
"sort_direction": {
"description": "Sort direction (default ASC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_get_time_off_usage(date_from, date_to, time_off_type_ids, team_id, location_id, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"date_from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Range start (YYYY-MM-DD)."
},
"date_to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Range end (YYYY-MM-DD)."
},
"time_off_type_ids": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": "Time off type ids (from kiwihr_list_time_off_types)."
},
"team_id": {
"description": "Only employees of this team.",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"location_id": {
"description": "Only employees at this location.",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"is_active": {
"description": "true = active employees only.",
"type": "boolean"
},
"sort_by": {
"type": "string",
"enum": [
"firstName",
"lastName"
]
},
"sort_direction": {
"description": "Sort direction (default ASC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"date_from",
"date_to",
"time_off_type_ids"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_timesheets(user_id, date_from, date_to, offset, limit)
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.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"description": "Employee id. Omit for the admin user the API key acts as.",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"date_from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Range start (YYYY-MM-DD)."
},
"date_to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Range end (YYYY-MM-DD)."
},
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Days per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"date_from",
"date_to"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_get_timesheet(user_id, date)
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.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"description": "Employee id. Omit for the admin user the API key acts as.",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Day (YYYY-MM-DD)."
}
},
"required": [
"date"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_get_attendance_statement(user_id, date_from, date_to)
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.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Employee id."
},
"date_from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Range start (YYYY-MM-DD)."
},
"date_to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Range end (YYYY-MM-DD)."
}
},
"required": [
"user_id",
"date_from",
"date_to"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_attendance_statements(date_from, date_to, project_id, has_uncategorized_time, include_inactive_users, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"date_from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Range start (YYYY-MM-DD)."
},
"date_to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Range end (YYYY-MM-DD)."
},
"project_id": {
"description": "Only employees with tracked time in this project.",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"has_uncategorized_time": {
"description": "true = only employees with tracked time not assigned to any project.",
"type": "boolean"
},
"include_inactive_users": {
"description": "Also include deactivated employees (default false).",
"type": "boolean"
},
"sort_by": {
"type": "string",
"enum": [
"firstName",
"lastName"
]
},
"sort_direction": {
"description": "Sort direction (default ASC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
},
"required": [
"date_from",
"date_to"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_overtime_balances(sort_by, sort_direction, offset, limit)
Current overtime balance (seconds) per employee. GraphQL query overtimeBalanceStatements.
Input Schema
{
"type": "object",
"properties": {
"sort_by": {
"type": "string",
"enum": [
"firstName",
"lastName",
"date",
"balance"
]
},
"sort_direction": {
"description": "Sort direction (default ASC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_projects(status, sort_by, sort_direction, offset, limit)
List time-tracking projects (id, name, status ACTIVE or INACTIVE). GraphQL query projects.
Input Schema
{
"type": "object",
"properties": {
"status": {
"description": "Only projects with this status.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
]
},
"sort_by": {
"type": "string",
"enum": [
"id",
"name"
]
},
"sort_direction": {
"description": "Sort direction (default ASC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_get_project(project_id)
One time-tracking project by id (name, status). GraphQL query project.
Input Schema
{
"type": "object",
"properties": {
"project_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Project id."
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_journeys(status, assignee_ids, journey_type_ids, team_ids, offset, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"status": {
"description": "Only journeys with this status.",
"type": "string",
"enum": [
"DRAFT",
"ONGOING",
"COMPLETED",
"CANCELLED"
]
},
"assignee_ids": {
"description": "Only journeys assigned to these employee ids.",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"journey_type_ids": {
"description": "Only these journey types (from kiwihr_list_journey_types).",
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"team_ids": {
"description": "Only journeys of employees in these teams.",
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_get_journey(journey_id, include_personal)
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.
Input Schema
{
"type": "object",
"properties": {
"journey_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Journey id."
},
"include_personal": {
"description": "Also return the private e-mail on the journey. Default false.",
"type": "boolean"
}
},
"required": [
"journey_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_journey_templates(journey_type_id, offset, limit)
List journey templates (id, name, description, type). Use a template id with kiwihr_create_journey. GraphQL query journeyTemplates.
Input Schema
{
"type": "object",
"properties": {
"journey_type_id": {
"description": "Only templates of this journey type.",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢kiwihr_list_journey_types(offset, limit)
List journey types such as pre-onboarding, onboarding or offboarding (id, name, key, archived date). GraphQL query journeyTypes.
Input Schema
{
"type": "object",
"properties": {
"offset": {
"description": "Items to skip (default 0). The reply's pageInfo.next says whether there is another page.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Items per page (1-100, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡kiwihr_create_timesheet_entry(user_id, date, type, start_at, end_at, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"description": "Employee id. Omit for the admin user the API key acts as.",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Day (YYYY-MM-DD)."
},
"type": {
"type": "string",
"enum": [
"MANUAL",
"BREAK"
],
"description": "MANUAL = worked time, BREAK = break."
},
"start_at": {
"description": "Start time HH:mm:ss.",
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"
},
"end_at": {
"description": "End time HH:mm:ss.",
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"
},
"part_of_day": {
"description": "For day-based tracking instead of start/end.",
"type": "string",
"enum": [
"FULL_DAY",
"MORNING",
"AFTERNOON"
]
},
"project_id": {
"description": "Project id (from kiwihr_list_projects).",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"note": {
"description": "Note for the entry.",
"type": "string",
"maxLength": 1000
}
},
"required": [
"date",
"type"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴kiwihr_update_timesheet_entry(entry_id, start_at, end_at, part_of_day, project_id, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Timesheet entry id."
},
"start_at": {
"description": "New start time HH:mm:ss.",
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"
},
"end_at": {
"description": "New end time HH:mm:ss.",
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"
},
"part_of_day": {
"description": "New part of day.",
"type": "string",
"enum": [
"FULL_DAY",
"MORNING",
"AFTERNOON"
]
},
"project_id": {
"description": "New project id.",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"note": {
"description": "New note.",
"type": "string",
"maxLength": 1000
}
},
"required": [
"entry_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴kiwihr_delete_timesheet_entry(entry_id)
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.
Input Schema
{
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Timesheet entry id."
}
},
"required": [
"entry_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡kiwihr_create_project(name, status)
WRITE: create a time-tracking project (name, status ACTIVE or INACTIVE; default ACTIVE). Creates a new project each call (not idempotent). GraphQL mutation createProject.
Input Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Project name."
},
"status": {
"description": "ACTIVE projects can be used for time tracking.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
]
}
},
"required": [
"name"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴kiwihr_update_project(project_id, name, status)
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.
Input Schema
{
"type": "object",
"properties": {
"project_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Project id."
},
"name": {
"description": "New name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status": {
"description": "New status.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
]
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡kiwihr_create_user(first_name, last_name, email, employment_start_date, manager_id, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"first_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"last_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"email": {
"type": "string",
"maxLength": 200,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Work e-mail address."
},
"employment_start_date": {
"description": "First day of employment (YYYY-MM-DD).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"manager_id": {
"description": "Manager's employee id.",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"team_ids": {
"description": "Team ids (from kiwihr_list_teams).",
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"position_id": {
"description": "Position id (from kiwihr_list_positions).",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"location_id": {
"description": "Location id (from kiwihr_list_locations).",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"work_phones": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50
}
},
"gender": {
"type": "string",
"enum": [
"MALE",
"FEMALE",
"DIVERSE"
]
}
},
"required": [
"first_name",
"last_name",
"email"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴kiwihr_update_user(user_id, first_name, last_name, employment_start_date, about_me, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Employee id."
},
"first_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"last_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"employment_start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"about_me": {
"type": "string",
"maxLength": 2000
},
"work_phones": {
"description": "Replaces the list of work phones.",
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50
}
},
"position_id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"team_ids": {
"description": "Replaces the list of teams.",
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"location_id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"manager_id": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴kiwihr_deactivate_user(user_id)
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.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Employee id."
}
},
"required": [
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}⚪kiwihr_activate_user(user_id)
WRITE: re-activate a deactivated employee so they appear in active lists and can use kiwiHR again. GraphQL mutation activateUser.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Employee id."
}
},
"required": [
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡kiwihr_create_journey(journey_type_id, assignee_id, journey_template_id, name, personal_email, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"journey_type_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Journey type id."
},
"assignee_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Employee id the journey is for."
},
"journey_template_id": {
"description": "Journey template id.",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"name": {
"description": "Journey name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"personal_email": {
"description": "Private e-mail (for pre-onboarding).",
"type": "string",
"maxLength": 200,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"custom_date": {
"description": "Custom date steps can relate to (YYYY-MM-DD).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"custom_date_name": {
"description": "Label of the custom date.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"pre_onboarding_access": {
"description": "Enable pre-onboarding access.",
"type": "boolean"
}
},
"required": [
"journey_type_id",
"assignee_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Evidence