humaans.
Guides and Resources
Connection Setup Guide
Step-by-step instructions to connect your Humaans account to Kombo.
Sandbox Environment
Access the Humaans sandbox environment for testing and development.
Supported Features & Coverage
- Models
- Actions
- Features
- Create Employee with Form
Legal Entities
Legal Entities
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name |
Work Locations
Work Locations
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| address |
Employees
Employees
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_number | |
| first_name | |
| last_name | |
| nationality | |
| display_full_name | |
| job_title | |
| work_email | |
| personal_email | |
| mobile_phone_number | |
| tax_id | |
| gender | |
| employment_status | |
| employment_type | |
| work_location_id | |
| legal_entity_id | |
| manager_id | |
| home_address | |
| bank_accounts | |
| date_of_birth | |
| start_date | |
| termination_date | |
| remote_created_at | |
| custom_fields | |
| integration_fields |
Absence Types
Absence Types
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| unit | |
| half_days_supported |
Absences
Absences
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| approver_id | |
| start_date | |
| end_date | |
| start_half_day | |
| end_half_day | |
| amount | |
| unit | |
| status | |
| employee_note | |
| type_id |
Employments
Employments
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| job_title | |
| pay_rate | |
| pay_period | |
| employment_type | |
| pay_currency | |
| effective_date |
Groups
Groups
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| type |
Time Off Balances
Time Off Balances
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| type_id | |
| balance | |
| balance_unit | |
| used | |
| used_unit |
Employee <> Group
Employee <> Group
| Field | Notes |
|---|---|
| employee_id | |
| team_id | |
| id | |
| changed_at | |
| remote_deleted_at |
Create employee
Create employee
Humaans requires a location to be set for the employee. We set it to to the first location in the system by default. You can change it by setting the
location_id the request body.| Input Field | Notes |
|---|---|
| first_name | |
| last_name | |
| work_email | |
| gender | |
| job_title | |
| home_address.street_1 | |
| home_address.city | |
| home_address.state | |
| home_address.zip_code | |
| home_address.country | |
| date_of_birth | |
| mobile_phone_number | |
| nationality | |
| start_date | |
| location_id |
Create employee (v2)
Create employee (v2)
For detailed information about creating employees with form, please see the Create Employee with Form tab above.
| Input Field | Notes |
|---|---|
| staffing_entity_id | |
| properties |
| Feature | Notes |
|---|---|
| API Passthrough | |
| Scope Testing | |
| Per Model Tests | |
| Per Field Tests | The Humaans API returns null values both if the API does not have permissions to access the field, and if the field simply does not have a value. The permission test therefore only checks for the presence of very common fields (e.g. birthday) where it is safe to assume that a null value is due to lack of permissions rather than due to a value not being set. |
| Custom Field Explorer | |
| Employees | |
| Connection Guide | |
| Prerequisites | |
| Create credentials | |
| Group Types | |
| TEAM | |
| DEPARTMENT |
Employment end date requires a leaving reason.
Some required form fields are referencing the following data models:
- Locations
- Employees
text
required
Work Email
Work email address for the employee. Must be unique in Humaans.
Unified field:
Work email address for the employee. Must be unique in Humaans.
Unified field:
work_emailtext
required
First Name
The first name of the employee
Unified field:
The first name of the employee
Unified field:
first_nametext
required
Last Name
The last name of the employee
Unified field:
The last name of the employee
Unified field:
last_namesingle_select
required
Location
The Kombo ID of the location the employee should be in
Unified field:
References
The Kombo ID of the location the employee should be in
Unified field:
location_idReferences
/v1/hris/locations?remote_model=locationdate
required
Start Date
Start date of the employee. Also considered to be the hire date
Unified field:
Start date of the employee. Also considered to be the hire date
Unified field:
start_dateobject
required
text
Middle Name
text
Preferred Name
text
Pronouns
single_select
Gender
The gender of the employee
Unified field:
The gender of the employee
Unified field:
genderdate
Date of Birth
The employee’s date of birth
Unified field:
The employee’s date of birth
Unified field:
date_of_birthcheckbox
Hide Birthday
If enabled, the birthday will be hidden from others.
If enabled, the birthday will be hidden from others.
text
Private Email
The private email address of the employee
Unified field:
The private email address of the employee
Unified field:
private_emailtext
Mobile Phone Number
The mobile phone number of the employee
Unified field:
The mobile phone number of the employee
Unified field:
mobile_phone_numbertext
Home Phone Number
The home phone number of the employee
Unified field:
The home phone number of the employee
Unified field:
home_phone_numbercheckbox
Hide Work Email
If enabled, hides the work email inside Humaans.
If enabled, hides the work email inside Humaans.
text
Street 1
The street address of the employee
Unified field:
The street address of the employee
Unified field:
home_address.street_1text
City
The city of the employee
Unified field:
The city of the employee
Unified field:
home_address.citytext
State
The state of the employee
Unified field:
The state of the employee
Unified field:
home_address.statetext
ZIP Code
The ZIP code of the employee
Unified field:
The ZIP code of the employee
Unified field:
home_address.zip_codetext
Country
ISO country code (e.g. US, GB).
Unified field:
ISO country code (e.g. US, GB).
Unified field:
home_address.countrytext
Remote City
text
Remote Country Code
ISO country code for the remote location (e.g. US). Not required for on-site employees.
ISO country code for the remote location (e.g. US). Not required for on-site employees.
text
Nationality
text
Bio
text
LinkedIn
text
Twitter
text
GitHub
date
First Working Day
First day at work. Defaults to the employment start date if omitted.
First day at work. Defaults to the employment start date if omitted.
date
Probation End Date
Must be after the start date.
Must be after the start date.
text
Employee ID
single_select
Contract Type
date
Employment End Date
Must be after the first working day. Requires a leaving reason.
Must be after the first working day. Requires a leaving reason.
single_select
Leaving Reason
text
Leaving Note
text
Tax ID
text
Tax Code
text
Payroll Provider
array
Working Days
List of days the employee is scheduled to work. Defaults to Monday–Friday when omitted.
List of days the employee is scheduled to work. Defaults to Monday–Friday when omitted.
Show items
Show items
single_select
required
Day