Skip to main content
KiwiHR
KiwiHR
44 actions · 1 auth method
PreviewHRIS

​
Authentication

API Key

A KiwiHR (Tellent HR) Company API key generated by an account Administrator is required. Requests run on behalf of the f…Guides: Connector Profile, Link Account
Actions
44 actions
Action
Description
Test Connection
Verifies the API key is valid by fetching a minimal user list.
List Users
Retrieve a paginated list of users in the company.
Get User
Retrieve a single user by ID.
List Available Managers
Retrieve a paginated list of users available to be assigned as managers.
Create User
Create a new user in the company.
Update User
Update an existing user’s profile.
Activate User
Activate a deactivated user by ID.
Deactivate User
Deactivate an active user by ID.
Delete User
Permanently delete a user by ID.
List Timesheets
Retrieve a paginated list of timesheets for a date range.
Get Timesheet
Retrieve a single timesheet for a specific date.
Create Timesheet Entry
Create a new timesheet entry (type MANUAL, BREAK, or TRACKER) for a specific date.
Update Timesheet Entry
Update an existing timesheet entry.
Delete Timesheet Entry
Delete a timesheet entry by ID.
List Time Off Balances
Retrieve a paginated list of time off balances for all users.
List Time Off Types
Retrieve a paginated list of time off types configured in the company.
List Time Off Request Usage Statements
Retrieve time off request usage statements for a date range and time off type IDs.
Get Attendance Statement
Retrieve the attendance statement for a specific user and date range.
List Attendance Statements
Retrieve a paginated list of attendance statements filtered by date range.
List Journeys
Retrieve a paginated list of journeys assigned to employees.
Get Journey
Retrieve a single journey by ID.
List Journey Templates
Retrieve a paginated list of journey templates available in the company.
Get Journey Template
Retrieve a single journey template by ID.
List Journey Types
Retrieve a paginated list of journey types (e.g. onboarding, offboarding).
Create Journey
Create a new journey and assign it to an employee.
Update Journey
Update an existing journey by ID.
Delete Journey
Delete a journey by ID.
List Projects
Retrieve a paginated list of projects in the company.
Get Project
Retrieve a single project by ID.
Create Project
Create a new project in the company.
Update Project
Update an existing project by ID.
Delete Project
Delete a project by ID.
List Collections
Retrieve a paginated list of all collections in the company.
Get Collection
Retrieve a single collection by ID.
Get Collection Item
Retrieve a single collection item record by ID.
List User Collections
Retrieve a paginated list of collections populated with a specific user’s data.
List User Scope Collection Items
Retrieve all collection items for a specific collection, optionally filtered by user.
List Overtime Balance Statements
Retrieve a paginated list of overtime balance statements for all employees.
List Overtime Balance Transactions
Retrieve a paginated list of overtime balance transactions for a specific user.
List Custom Fields
Retrieve a paginated list of custom field definitions for the company.
Get Custom Field
Retrieve a single custom field definition by ID.
List Locations
Retrieve a paginated list of work locations in the company.
List Teams
Retrieve a paginated list of teams (departments) in the company.
List Positions
Retrieve a paginated list of job positions in the company.

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/kiwihr/filled/png

Connector Profile

KiwiHR - API Key
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/kiwihr/filled/png

Link Account

KiwiHR - API Key
4

Use Actions

Invoke actions using one of the methods below: