> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# KiwiHR

> How to set up the KiwiHR connector, plus the actions that are available.

![KiwiHR](https://stackone-logos.com/api/kiwihr/filled/svg)

v1.1.0[See changelog](https://docs.stackone.com/connectors/kiwihr/changelog.md)

[44 actions](#actions) · 1 auth method

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/kiwihr/guides/connector-profile/api-key.md)
>
> A KiwiHR (Tellent HR) Company API key generated by an account Administrator is required. Requests run on behalf of the f...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/kiwihr/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

44 actions

ActionDescription

Test Connection`kiwihr_test_connection`

Verifies the API key is valid by fetching a minimal user list.

List Users`kiwihr_list_users`

Retrieve a paginated list of users in the company.

Get User`kiwihr_get_user`

Retrieve a single user by ID.

List Available Managers`kiwihr_list_available_managers`

Retrieve a paginated list of users available to be assigned as managers.

Create User`kiwihr_create_user`

Create a new user in the company.

Update User`kiwihr_update_user`

Update an existing user's profile.

Activate User`kiwihr_activate_user`

Activate a deactivated user by ID.

Deactivate User`kiwihr_deactivate_user`

Deactivate an active user by ID.

Delete User`kiwihr_delete_user`

Permanently delete a user by ID.

List Timesheets`kiwihr_list_timesheets`

Retrieve a paginated list of timesheets for a date range.

Get Timesheet`kiwihr_get_timesheet`

Retrieve a single timesheet for a specific date.

Create Timesheet Entry`kiwihr_create_timesheet_entry`

Create a new timesheet entry (type MANUAL, BREAK, or TRACKER) for a specific date.

Update Timesheet Entry`kiwihr_update_timesheet_entry`

Update an existing timesheet entry.

Delete Timesheet Entry`kiwihr_delete_timesheet_entry`

Delete a timesheet entry by ID.

List Time Off Balances`kiwihr_list_time_off_balances`

Retrieve a paginated list of time off balances for all users.

List Time Off Types`kiwihr_list_time_off_types`

Retrieve a paginated list of time off types configured in the company.

List Time Off Request Usage Statements`kiwihr_list_time_off_request_usage_statements`

Retrieve time off request usage statements for a date range and time off type IDs.

Get Attendance Statement`kiwihr_get_attendance_statement`

Retrieve the attendance statement for a specific user and date range.

List Attendance Statements`kiwihr_list_attendance_statements`

Retrieve a paginated list of attendance statements filtered by date range.

List Journeys`kiwihr_list_journeys`

Retrieve a paginated list of journeys assigned to employees.

Get Journey`kiwihr_get_journey`

Retrieve a single journey by ID.

List Journey Templates`kiwihr_list_journey_templates`

Retrieve a paginated list of journey templates available in the company.

Get Journey Template`kiwihr_get_journey_template`

Retrieve a single journey template by ID.

List Journey Types`kiwihr_list_journey_types`

Retrieve a paginated list of journey types (e.g. onboarding, offboarding).

Create Journey`kiwihr_create_journey`

Create a new journey and assign it to an employee.

Update Journey`kiwihr_update_journey`

Update an existing journey by ID.

Delete Journey`kiwihr_delete_journey`

Delete a journey by ID.

List Projects`kiwihr_list_projects`

Retrieve a paginated list of projects in the company.

Get Project`kiwihr_get_project`

Retrieve a single project by ID.

Create Project`kiwihr_create_project`

Create a new project in the company.

Update Project`kiwihr_update_project`

Update an existing project by ID.

Delete Project`kiwihr_delete_project`

Delete a project by ID.

List Collections`kiwihr_list_collections`

Retrieve a paginated list of all collections in the company.

Get Collection`kiwihr_get_collection`

Retrieve a single collection by ID.

Get Collection Item`kiwihr_get_collection_item`

Retrieve a single collection item record by ID.

List User Collections`kiwihr_list_user_collections`

Retrieve a paginated list of collections populated with a specific user's data.

List User Scope Collection Items`kiwihr_list_user_scope_collection_items`

Retrieve all collection items for a specific collection, optionally filtered by user.

List Overtime Balance Statements`kiwihr_list_overtime_balance_statements`

Retrieve a paginated list of overtime balance statements for all employees.

List Overtime Balance Transactions`kiwihr_list_overtime_balance_transactions`

Retrieve a paginated list of overtime balance transactions for a specific user.

List Custom Fields`kiwihr_list_custom_fields`

Retrieve a paginated list of custom field definitions for the company.

Get Custom Field`kiwihr_get_custom_field`

Retrieve a single custom field definition by ID.

List Locations`kiwihr_list_locations`

Retrieve a paginated list of work locations in the company.

List Teams`kiwihr_list_teams`

Retrieve a paginated list of teams (departments) in the company.

List Positions`kiwihr_list_positions`

Retrieve a paginated list of job positions in the company.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.