hibob.
Guides and Resources
Supported Features & Coverage
- Models
- Actions
- Features
- Create Employee with Form
Work Locations
Work Locations
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| address | |
| type | |
| remote_data |
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 | |
| ssn | |
| gender | |
| ethnicity | |
| marital_status | |
| employment_status | |
| employment_type | |
| weekly_hours | |
| avatar | |
| work_location_id | |
| manager_id | |
| home_address | |
| bank_accounts | |
| date_of_birth | |
| start_date | |
| termination_date | |
| remote_created_at | |
| custom_fields | |
| integration_fields | |
| remote_data |
Absence Types
Absence Types
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| unit | |
| remote_data |
Absences
Absences
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| start_date | |
| end_date | |
| start_half_day | |
| end_half_day | |
| start_time | |
| end_time | |
| amount | |
| unit | |
| status | |
| type_id | |
| remote_data |
Employments
Employments
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| job_title | |
| pay_rate | |
| pay_period | |
| pay_frequency | |
| employment_type | |
| pay_currency | |
| effective_date | |
| remote_data | |
| custom_fields | |
| integration_fields |
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 | |
| remote_data |
Employee Document Categories
Employee Document Categories
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| remote_data |
Employee <> Group
Employee <> Group
| Field | Notes |
|---|---|
| employee_id | |
| team_id | |
| id | |
| changed_at | |
| remote_deleted_at |
Create absence
Create absence
Specifying absence status might not work consistently for all absence types
| Input Field | Notes |
|---|---|
| employee_id | |
| absence_type_id | |
| status | |
| start_date | |
| end_date | |
| start_half_day | |
| end_half_day | |
| employee_note |
Delete absence
Delete absence
| Input Field | Notes |
|---|---|
| absence_id |
Create employee
Create employee
HiBob requires a start date for the employee. If
start_date is not provided, we will use the current date. HiBob requires a work site for the employee. We use the first one we find in the system if location_id is not provided in the request body| Input Field | Notes |
|---|---|
| first_name | |
| last_name | |
| work_email | |
| gender | |
| job_title | |
| home_address.street_1 | |
| home_address.street_2 | |
| home_address.city | |
| home_address.state | |
| home_address.zip_code | |
| date_of_birth | |
| mobile_phone_number | |
| start_date | |
| location_id |
Create employee with form
Create employee with form
For detailed information about creating employees with form, please see the Create Employee with Form tab above.
| Input Field | Notes |
|---|---|
| properties |
Add document to employee
Add document to employee
| Input Field | Notes |
|---|---|
| employee_id | |
| category_id | |
| document.name | |
| document.content_type | |
| document.data_url | |
| document.data |
| Feature | Notes |
|---|---|
| Connection Guide | |
| Prerequisites | |
| Employment History | |
| API Passthrough | |
| Scope Testing | |
| Per Model Tests | |
| Per Field Tests | The individual field detection might be inconsistent |
| Delta Syncs | |
| Group Types | |
| DEPARTMENT | |
| COST_CENTER | |
| Custom Field Explorer | |
| Employees |
You can use the Regular API or the Hire API to create employees in HiBob. The Regular API creates employees directly in the system. With the Hire API, employees are created as new hires and need to be manually approved in HiBob’s dashboard.
- hire-api
- regular
First Name
The first name of the employee
Unified field:
The first name of the employee
Unified field:
first_nameLast Name
The last name of the employee
Unified field:
The last name of the employee
Unified field:
last_namePrivate Email
The private email address of the employee
Unified field:
The private email address of the employee
Unified field:
private_emailWork
Show properties
Show properties
Documents
They will be uploaded to the employee’s “Confidential” folder in HiBob.
They will be uploaded to the employee’s “Confidential” folder in HiBob.
Show items
Show items
Custom fields
Show properties
Show properties
Currency fields
Some optional form fields are referencing the following data models:
- Employees
This form may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
First Name
The first name of the employee
Unified field:
The first name of the employee
Unified field:
first_nameLast Name
The last name of the employee
Unified field:
The last name of the employee
Unified field:
last_nameFull name
Display name
Middle name
Avatar URL
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
Private Email
The private email address of the employee
Unified field:
The private email address of the employee
Unified field:
private_emailID
References
References
/v1/hris/employees?remote_model=employeeCompany id
Creation timestamp
Cover image URL
Financial
Show properties
Show properties
Passport number
National ID
Account name
Routing number
Account number
Bank name
Bank account type
Branch address
SWIFT code
IBAN
Sort code
Account type
Right to work closest expiry date
Payroll
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
NI number
Employment
Show properties
Show properties
Employment effective date
Employment contract
Employment type
Working pattern
Standard working pattern
Show properties
Show properties
Full time working pattern
Personal working pattern
Hours in days not worked
Site working pattern
Actual working pattern
Holiday calendar ID
Salary pay type
FLSA code
FTE %
Weekly hours
Salary
Show properties
Show properties
Salary effective date
Salary pay period
Salary pay frequency
Base salary (annual)
Unified field:
Unified field:
yearly_salaryBase salary (monthly)
Additional pension contribution
Tax code
Time since last salary change
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
Variable
Show properties
Show properties
Show properties
Show properties
Variable pay Executive bonus Amount
Variable pay Executive bonus Pay period
Variable pay Executive bonus % company
Variable pay Executive bonus % department
Variable pay Executive bonus % individual
Entitlement
Show properties
Show properties
Deduction
Show properties
Show properties
Work
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
Work effective date
Employee ID
Job title
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_dateWork anniversary
Original start date
Accumulated tenure (duration)
Accumulated tenure (years)
Tenure (duration)
Tenure (years)
Work anniversary (years)
Site
The employee’s site.
The employee’s site.
Site
Department
Change type
Manager’s ID
Manager
References
References
/v1/hris/employees?remote_model=employeeSecond level manager
References
References
/v1/hris/employees?remote_model=employeeIs a manager
Number of direct reports
Number of direct and indirect reports
Tenure sum of previous lifecycle entries in days
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
Work mobile
Work phone
Employee
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
Buddy
References
References
/v1/hris/employees?remote_model=employeeHRBP
References
References
/v1/hris/employees?remote_model=employeePayroll manager
References
References
/v1/hris/employees?remote_model=employeeIT admin
References
References
/v1/hris/employees?remote_model=employeeOrg level
Disability status
Veteran status
Legal sex
Recent leave start date
Recent leave end date
Last day of work
Ethnicities
Job
Employee.has paid payslip
Repaying student or postgraduate loan type
Field should be blank if not repaying student loans. If repaying a student loan but unsure of the plan type, select “Plan 1”.
Field should be blank if not repaying student loans. If repaying a student loan but unsure of the plan type, select “Plan 1”.
Address
Show properties
Show properties
Address line 1
Address line 2
Full address
City
Zip Post Postal code
Country
State Province Region
Site address line 1
Site address line 2
Site country
Site zip Post Postal code
Site city
Site state Province Region
Address effective date
Home
Show properties
Show properties
Marital status
Gender
Number of children
Personal email
Personal phone
Personal mobile
About
Show properties
Show properties
Employment
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
Personal contact
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
Emergency
Show properties
Show properties
Emergency contact’s first name
Emergency contact’s middle name
Emergency contact’s last name
Emergency contact relationship
Emergency contact’s phone number
Emergency contact’s mobile phone number
Emergency contact’s email
Emergency contact’s address
Emergency contact’s city of residence
Emergency contact’s post code
Emergency contact’s country of residence
Internal
Show properties
Show properties
Lifecycle status
Status
Reason for termination
Termination date
Period since termination
Years since termination
Notice period
Probation end date
Leave and termination type
Current active lifecycle start date
State
Creation date
User data
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
Eeo
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
Ethnicity
Job category
Custom
Show properties
Show properties
This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
People analytics
Show properties
Show properties
Kids risk indicator
Age risk indicator
Is manager risk indicator
Number of people with the same title risk indicator
Team size risk indicator
Years with current title risk indicator
Years with recent salary risk indicator
Manager tenure risk indicator
Number of direct reports risk indicator
Team recent turnover risk indicator
Timeoff frequency risk indicator
Tenure rank risk indicator
Recent manager change risk indicator
Number of ‘low risk’ indicators
Number of ‘some risk’ indicators
Number of ‘at risk’ indicators