HiBob
App · 26 actions
Read employee profiles, histories, time off and tasks; create and update employees in HiBob.
Actions
| Action | What it does |
|---|---|
| Create employee | Add a new employee to HiBob with their name, email, site and start date. |
| Get avatar | Get the web address of an employee's profile picture. |
| Get company list | Get one of your company's HiBob lists and its items by the list's name, such as department, site or title. |
| Get employee | Read one employee's details by their HiBob employee ID or email address: name, email, job title, department, site, start date, and their manager's name and email. |
| Get policy type | Get the details of one time off policy type, such as Holiday or Sick. |
| Get time off balance | Get an employee's time off balance for one policy type, as of a date. |
| Get time off policy | Get the details of one time off policy by its name, such as its yearly allowance. |
| Get time off request | Get the details of one time off request: its dates, length, status and who approved it. |
| List company lists | List your company's HiBob lists, such as departments, sites and job titles, with the items in each. |
| List employee fields | List every field your company keeps on employees in HiBob, including the ones your company added, with each field's ID, name and type. |
| List employees with a date in a period | Find the employees whose probation ends, who start work, or who have a work anniversary this month, next month or between two dates. |
| List employment history | List an employee's employment history: each change of contract, employment type, working pattern or weekly hours, with the date it took effect. |
| List equity grants | List an employee's equity grants. |
| List lifecycle history | List an employee's lifecycle history: each status, such as Hired, Employed, Garden leave or Terminated, with the date it took effect. |
| List onboarding wizards | List your company's onboarding wizards, with their IDs and names. |
| List out today | List who is out of the office today, or on a date you choose. |
| List policy names | List the names of the time off policies under one policy type. |
| List policy types | List the names of your company's time off policy types. |
| List profiles | List the public profile of every active employee: name, email, job title, department, site, start date, and their manager's name and email. |
| List salary history | List an employee's salary history: each pay change with its amount, currency, pay period and the date it took effect. |
| List tasks | List every open task in HiBob (HiBob returns at most 5,000), with who each is for, who owns it and when it is due. |
| List training | List an employee's training records. |
| List whos out | List who is out of the office between two dates, with the dates and type of each time off request. |
| List work history | List an employee's work history: each change of job title, department, site or manager, with the date it took effect. |
| Search employees | Read chosen details of every employee, or of particular employees by ID or email. |
| Update employee | Change an employee's first name, surname or personal mobile number. |
Create employee
Add a new employee to HiBob with their name, email, site and start date.
Inputs
- First name
first_nametextRequired - The employee's first name, up to 50 characters: letters, plus hyphens, apostrophes, full stops and a few other marks.
- Surname
surnametextRequired - The employee's surname, up to 50 characters: letters, plus hyphens, apostrophes, full stops and a few other marks.
- Email
emailtextRequired - The employee's email address. No other employee in the company may already have it.
- Site
work_sitetextRequired - The site the employee works at, by its name in your company's Site list in HiBob.
- Start date
work_start_datedateRequired - The employee's first day of work.
- Department
work_departmenttext - The employee's department, by its name in your company's Department list in HiBob.
- Job title
work_titletext - The employee's job title, by its name in your company's Job title list in HiBob.
Outputs
dataobject- Data.
Example output
{
"data": {
"/about/about": {
"value": "example"
},
"/about/avatar": {
"value": "example"
},
"/about/foodPreferences": {
"value": "example"
},
"/about/superpowers": {
"value": []
},
"/root/avatarUrl": {
"value": "example"
},
"/root/companyId": {
"value": 1.0
},
"/root/coverImageUrl": {
"value": "example"
},
"/root/displayName": {
"value": "example"
},
"/root/email": {
"value": "example"
},
"/root/firstName": {
"value": "example"
},
"/root/fullName": {
"value": "example"
},
"/root/id": {
"value": "example"
},
"/work/activeEffectiveDate": {
"value": "example"
},
"/work/daysOfPreviousService": {
"value": 1.0
},
"/work/department": {
"value": "example"
},
"/work/directReports": {
"value": 1.0
},
"/work/durationOfEmployment": {
"value": {
"humanize": "example",
"periodISO": "example",
"sortFactor": 1.0
}
},
"/work/employeeIdInCompany": {
"value": 1.0
},
"/work/indirectReports": [],
"/work/isManager": {
"value": false
},
"/work/manager": {
"value": "example"
},
"/work/originalStartDate": {
"value": "example"
},
"/work/reportsTo": {
"value": {
"displayName": "example",
"email": "example",
"firstName": "example",
"id": "example",
"surname": "example"
}
},
"/work/reportsTo/email": {
"value": "example"
},
"/work/reportsToIdInCompany": {
"value": 1.0
},
"/work/secondLevelManager": {
"value": "example"
},
"/work/shortStartDate": {
"value": "example"
},
"/work/site": {
"value": "example"
},
"/work/siteId": {
"value": 1.0
},
"/work/tenureDuration": {
"value": {
"humanize": "example",
"periodISO": "example",
"sortFactor": 1.0
}
},
"/work/tenureDurationYears": {
"value": 1.0
},
"/work/tenureYears": {
"value": "example"
},
"/work/title": {
"value": "example"
},
"/work/yearsOfService": {
"value": 1.0
},
"about": {
"about": "example",
"avatar": "example",
"foodPreferences": [],
"hobbies": [],
"socialData": {
"facebook": "example",
"linkedin": "example",
"twitter": "example"
},
"superpowers": []
},
"avatarUrl": "example",
"companyId": 1.0,
"coverImageUrl": "example",
"creationDateTime": "example",
"displayName": "example",
"email": "example",
"employee": {
"buddy": "example",
"hrbp": "example",
"itAdmin": "example",
"payrollManager": "example"
},
"firstName": "example",
"fullName": "example",
"hobbies": {
"value": []
},
"id": "example",
"secondName": "example",
"surname": "example",
"work": {
"activeEffectiveDate": "example",
"custom": {},
"daysOfPreviousService": 1.0,
"department": "example",
"directReports": 1.0,
"durationOfEmployment": {
"humanize": "example",
"periodISO": "example",
"sortFactor": 1.0
},
"employeeIdInCompany": 1.0,
"indirectReports": 1.0,
"isManager": "example",
"manager": "example",
"originalStartDate": "example",
"reportsTo": {
"displayName": "example",
"email": "example",
"firstName": "example",
"id": "example",
"surname": "example"
},
"reportsToIdInCompany": 1.0,
"secondLevelManager": "example",
"shortStartDate": "example",
"site": "example",
"siteID": 1.0,
"startDate": "example",
"tenureDuration": {
"humanize": "example",
"periodISO": "example",
"sortFactor": 1.0
},
"tenureDurationYears": 1.0,
"tenureYears": 1.0,
"title": "example",
"workMobile": "example",
"workPhone": "example",
"yearsOfService": 1.0
}
}
}Get avatar
Get the web address of an employee's profile picture.
Inputs
- Employee
employee_idtextRequired - The employee whose picture to get: pick one, or give their HiBob employee ID.
Outputs
dataobject- Data.
Example output
{
"data": {
"url": "example"
}
}Get company list
Get one of your company's HiBob lists and its items by the list's name, such as department, site or title.
Inputs
- List name
list_nametextRequired - The list's name in HiBob, such as department, site or title (List company lists shows every name).
- Include archived
include_archivedtrue/false - Also return list items that have been archived. Off by default.Default:
false.
Outputs
dataobject- Data.
Example output
{
"data": {
"items": [],
"name": "example"
}
}Get employee
Read one employee's details by their HiBob employee ID or email address: name, email, job title, department, site, start date, and their manager's name and email. HiBob has no standard probation field: if your company added one, name it in Fields, or use "List employees with a date in a period".
Inputs
- Employee
identifiertextRequired - The employee to read: pick one, or give their HiBob employee ID or email address.
- Fields
fieldslist - The HiBob fields to return, by field ID, such as root.email or work.department (List employee fields shows every ID). Leave blank for HiBob's standard set: the employee's name and email and the About, Employment and Work sections. A field your company added, such as a probation end date, only comes back when it is named here. HiBob leaves out, without an error, any field the connected service user may not view.
- Readable values
human_readabletext - How to return what HiBob stores as a code, such as a department your company added (a list ID) or a manager (an employee ID). Leave blank for the stored values only. Add readable values also returns the names, under humanReadable on each employee. Readable values only returns every value as display text (dates in your company's format, the manager as a name without their email) and leaves out empty fields.One of:
APPEND(Add readable values),REPLACE(Readable values only).
Outputs
dataobject- HiBob's answer as it was sent. Read employee instead.
employeeobject- The employee. These are HiBob's standard details; ask for others in Fields. Each one asked for also comes back beside these under a key such as /work/startDate, holding its value. With Readable values only, every value is text instead and the manager is a name with no email.
Example output
{
"data": {},
"employee": {
"about": {
"about": "example",
"avatar": "example",
"foodPreferences": [],
"hobbies": [],
"socialData": {
"facebook": "example",
"linkedin": "example",
"twitter": "example"
},
"superpowers": []
},
"avatarUrl": "example",
"companyId": 1.0,
"coverImageUrl": "example",
"creationDateTime": "example",
"displayName": "example",
"email": "example",
"firstName": "example",
"fullName": "example",
"humanReadable": {
"work": {
"department": "example",
"reportsTo": "example",
"site": "example",
"startDate": "example",
"title": "example"
}
},
"id": "example",
"secondName": "example",
"surname": "example",
"work": {
"activeEffectiveDate": "example",
"custom": {},
"daysOfPreviousService": 1.0,
"department": "example",
"directReports": 1.0,
"durationOfEmployment": {
"humanize": "example",
"periodISO": "example",
"sortFactor": 1.0
},
"employeeIdInCompany": 1.0,
"indirectReports": 1.0,
"isManager": false,
"manager": "example",
"originalStartDate": "example",
"reportsTo": {
"displayName": "example",
"email": "example",
"firstName": "example",
"id": "example",
"surname": "example"
},
"reportsToIdInCompany": 1.0,
"secondLevelManager": "example",
"shortStartDate": "example",
"site": "example",
"siteId": 1.0,
"startDate": "example",
"tenureDuration": {
"humanize": "example",
"periodISO": "example",
"sortFactor": 1.0
},
"tenureDurationYears": 1.0,
"tenureYears": 1.0,
"title": "example",
"workMobile": "example",
"workPhone": "example",
"yearsOfService": 1.0
}
}
}Get policy type
Get the details of one time off policy type, such as Holiday or Sick.
Inputs
- Policy type
policy_typetextRequired - The time off policy type to read, such as Holiday.
Outputs
dataobject- Data.
Example output
{
"data": {
"activity": "paidTimeoff",
"name": "example",
"unit": "days"
}
}Get time off balance
Get an employee's time off balance for one policy type, as of a date.
Inputs
- Employee
idtextRequired - The employee whose balance to get: pick one, or give their HiBob employee ID.
- Policy type
policy_typetextRequired - The time off policy type, such as Holiday.
- Date
datedateRequired - The day to work the balance out for.
Outputs
dataobject- Data.
Example output
{
"data": {
"annualAllowance": 1.0,
"currentAssignment": "Assigned",
"employeeId": "example",
"pointInTime": "example",
"policy": "example",
"startingBalance": 1.0,
"startingBalanceAsOf": "example",
"totalAdminAdjustments": 1.0,
"totalBalanceAsOfDate": 1.0,
"totalRoundedBalanceAsOfDate": 1.0,
"totalSystemAdjustments": 1.0,
"totalTaken": 1.0
}
}Get time off policy
Get the details of one time off policy by its name, such as its yearly allowance.
Inputs
- Policy name
policy_nametextRequired - The time off policy's name, as List policy names returns it.
Outputs
dataobject- Data.
Example output
{
"data": {
"allowance": 1.0,
"approvalRequired": false,
"bookingWorkDaysOnly": false,
"description": "example",
"maxBalance": 1.0,
"minBalance": 1.0,
"minTimeOffRequestDuration": "fullDay",
"name": "example",
"unit": "days",
"yosIncrease": []
}
}Get time off request
Get the details of one time off request: its dates, length, status and who approved it.
Inputs
- Employee
idtextRequired - The employee who asked for the time off: pick one, or give their HiBob employee ID.
- Request ID
request_idnumberRequired - The time off request's number, which List whos out returns as requestId.
- Include daily durations
include_daily_durationstrue/false - Include a day-by-day breakdown of the request. On by default.Default:
true.
Outputs
dataobject- Data.
Example output
{
"data": {
"approved": false,
"approvedAt": "example",
"approvedBy": "example",
"attachmentLinks": [],
"createdOn": "example",
"declineReason": "example",
"declinedAt": "example",
"declinedBy": "example",
"description": "example",
"durationUnit": "days",
"durations": [],
"employeeId": "example",
"endDate": "example",
"endPortion": "example",
"hasAttachment": false,
"originalRequestId": 1,
"policyTypeCustomName": "example",
"policyTypeDisplayName": "example",
"previousRequestId": 1,
"reasonCode": "example",
"requestId": 1,
"startDate": "example",
"startPortion": "example",
"status": "example",
"timeZoneOffset": "example",
"totalCost": 1.0,
"totalDuration": 1.0,
"type": "days",
"visibility": "Public"
}
}List company lists
List your company's HiBob lists, such as departments, sites and job titles, with the items in each.
Inputs
- Include archived
include_archivedtrue/false - Also return list items that have been archived. Off by default.Default:
false.
Outputs
datalist- Data.
Example output
{
"data": []
}List employee fields
List every field your company keeps on employees in HiBob, including the ones your company added, with each field's ID, name and type. A field's ID is what Search employees and Get employee take in Fields.
Inputs
None.
Outputs
datalist- Data.
Example output
{
"data": []
}List employees with a date in a period
Find the employees whose probation ends, who start work, or who have a work anniversary this month, next month or between two dates. Each comes back as one ready-to-read record with their name, email, job title, department, start date, probation end date, and their manager's name and email, so reminding each manager needs no further lookups. HiBob has no standard probation field: the probation end date is read from the date field your company added for it, found by the word "probation" in its name.
Inputs
- Date
date_typetextRequired - Which date to look for. Probation ends: the employee's probation end date falls in the period. Start date: the employee starts work in the period. Work anniversary: the day and month the employee started falls in the period, in a later year.One of:
probation_end(Probation ends),start_date(Start date),work_anniversary(Work anniversary). - Period
periodtext - When the date must fall. Leave blank for this month, or for the dates in From and To when those are filled in. Months are calendar months in the workflow owner's time zone, so a run at 9:00 on the 1st gets the month that has just begun.One of:
this_month(This month),next_month(Next month),custom(Between two dates). - From
from_datedate - The first day of the period, for Between two dates.
- To
to_datedate - The last day of the period, for Between two dates. At most a year after From.
- Time zone
timezonetext - Usually left blank: this month and next month are counted in the workflow owner's time zone. Give a time zone by name, such as Australia/Sydney or America/New_York, to count them somewhere else. UTC is used only when this is blank and the owner has no time zone saved.
- Probation date field
probation_fieldtext - Usually left blank: the probation end date is read from the one date field in your HiBob account with "probation" in its name. Pick the field here when your company calls it something else, or has more than one.
Outputs
countnumber- How many employees were found.
date_labeltext- That date in words, such as Probation end date.
date_typetext- Which date was looked for: probation_end, start_date or work_anniversary.
employeeslist- The employees whose date falls in the period, earliest date first. Empty when there are none.
employees_checkednumber- How many current employees HiBob returned to check.
period_displaytext- The period ready to read, such as November 2026, or Nov 1, 2026 to Dec 15, 2026.
period_endtext- The last day of the period, as YYYY-MM-DD.
period_starttext- The first day of the period, as YYYY-MM-DD.
probation_field_nametext- The name of the HiBob field the probation end date was read from. Blank when your company has none.
timezonetext- The time zone this month and next month were counted in, such as Australia/Sydney.
Example output
{
"count": 1,
"date_label": "Probation end date",
"date_type": "probation_end",
"employees": [
{
"date": "2026-11-18",
"date_display": "Nov 18, 2026",
"department": "Product",
"email": "amy.miles@example.com",
"first_name": "Amy",
"id": "3332883911884669725",
"job_title": "Product Designer",
"manager_email": "zoe.clark@example.com",
"manager_id": "3332883909410030364",
"manager_name": "Zoe Clark",
"name": "Amy Miles",
"probation_end_date": "2026-11-18",
"probation_end_date_display": "Nov 18, 2026",
"site": "London",
"start_date": "2026-05-18",
"start_date_display": "May 18, 2026",
"years_of_service": null
}
],
"employees_checked": 42,
"period_display": "November 2026",
"period_end": "2026-11-30",
"period_start": "2026-11-01",
"probation_field_name": "Probation end date",
"timezone": "Europe/London"
}List employment history
List an employee's employment history: each change of contract, employment type, working pattern or weekly hours, with the date it took effect. HiBob's standard employment record has no probation date.
Inputs
- Employee
idtextRequired - The employee whose employment history to list: pick one, or give their HiBob employee ID.
- Include archived
include_archivedtrue/false - Also return columns your company has archived in HiBob. Off by default.Default:
false.
Outputs
dataobject- Data.
Example output
{
"data": {
"restricted_columns": {
"no_view_history_permission": [],
"no_view_permission": []
},
"values": []
}
}List equity grants
List an employee's equity grants.
Inputs
- Employee
idtextRequired - The employee whose equity grants to list: pick one, or give their HiBob employee ID.
- Include archived
include_archivedtrue/false - Also return columns your company has archived in HiBob. Off by default.Default:
false.
Outputs
dataobject- Data.
Example output
{
"data": {
"restricted_columns": {
"no_view_history_permission": [],
"no_view_permission": []
},
"values": []
}
}List lifecycle history
List an employee's lifecycle history: each status, such as Hired, Employed, Garden leave or Terminated, with the date it took effect.
Inputs
- Employee
idtextRequired - The employee whose lifecycle history to list: pick one, or give their HiBob employee ID.
- Include archived
include_archivedtrue/false - Also return columns your company has archived in HiBob. Off by default.Default:
false.
Outputs
dataobject- The employee's lifecycle history, under 'values'.
Example output
{
"data": {
"restricted_columns": {
"no_view_history_permission": [],
"no_view_permission": []
},
"values": []
}
}List onboarding wizards
List your company's onboarding wizards, with their IDs and names.
Inputs
None.
Outputs
dataobject- Data.
Example output
{
"data": {
"wizards": []
}
}List out today
List who is out of the office today, or on a date you choose.
Inputs
- Date
todaydate - The day to check. Leave blank for today (UTC).
- Include hourly
include_hourlytrue/false - Also return time off booked in hours rather than whole days.Default:
false. - Include private
include_privatetrue/false - Also return time off whose type is private, under its real name. The connected service user needs permission in HiBob to see private requests.Default:
false. - Site ID
site_idnumber - Only people at this site, by the site's number in HiBob.
Outputs
dataobject- Data.
Example output
{
"data": {
"outs": []
}
}List policy names
List the names of the time off policies under one policy type.
Inputs
- Policy type
policy_type_nametextRequired - The time off policy type whose policies to list, such as Holiday.
Outputs
dataobject- Data.
Example output
{
"data": {
"policyNames": []
}
}List policy types
List the names of your company's time off policy types.
Inputs
None.
Outputs
dataobject- Data.
Example output
{
"data": {
"policyTypes": []
}
}List profiles
List the public profile of every active employee: name, email, job title, department, site, start date, and their manager's name and email. Profiles don't include a probation date.
Inputs
None.
Outputs
dataobject- Data.
Example output
{
"data": {
"employees": []
}
}List salary history
List an employee's salary history: each pay change with its amount, currency, pay period and the date it took effect.
Inputs
- Employee
idtextRequired - The employee whose salary history to list: pick one, or give their HiBob employee ID.
- Include archived
include_archivedtrue/false - Also return columns your company has archived in HiBob. Off by default.Default:
false.
Outputs
dataobject- Data.
Example output
{
"data": {
"restricted_columns": {
"no_view_history_permission": [],
"no_view_permission": []
},
"values": []
}
}List tasks
List every open task in HiBob (HiBob returns at most 5,000), with who each is for, who owns it and when it is due.
Inputs
None.
Outputs
dataobject- Data.
Example output
{
"data": {
"tasks": []
}
}List training
List an employee's training records.
Inputs
- Employee
idtextRequired - The employee whose training records to list: pick one, or give their HiBob employee ID.
- Include archived
include_archivedtrue/false - Also return columns your company has archived in HiBob. Off by default.Default:
false.
Outputs
dataobject- Data.
Example output
{
"data": {
"restricted_columns": {
"no_view_history_permission": [],
"no_view_permission": []
},
"values": []
}
}List whos out
List who is out of the office between two dates, with the dates and type of each time off request.
Inputs
- From
from_datedateRequired - The first day of the period.
- To
todateRequired - The last day of the period.
- Include hourly
include_hourlytrue/false - Also return time off booked in hours rather than whole days.Default:
false. - Include private
include_privatetrue/false - Also return time off whose type is private, under its real name. The connected service user needs permission in HiBob to see private requests.Default:
false. - Include pending
include_pendingtrue/false - Also return requests still waiting for approval.Default:
false. - Include working requests
include_working_requeststrue/false - Return requests such as working from home or business travel, which HiBob records as time off although the person is working. On by default; turn off to list only real time off.Default:
true.
Outputs
dataobject- Array of time off requests; each item’s shape depends on its type.
Example output
{
"data": {
"outs": []
}
}List work history
List an employee's work history: each change of job title, department, site or manager, with the date it took effect.
Inputs
- Employee
idtextRequired - The employee whose work history to list: pick one, or give their HiBob employee ID.
- Include archived
include_archivedtrue/false - Also return columns your company has archived in HiBob. Off by default.Default:
false.
Outputs
dataobject- Data.
Example output
{
"data": {
"restricted_columns": {
"no_view_history_permission": [],
"no_view_permission": []
},
"values": []
}
}Search employees
Read chosen details of every employee, or of particular employees by ID or email. HiBob returns everyone in one answer and can only narrow the search by employee ID or email, not by department or date. To find people by a date (probation ending, starting, a work anniversary), use "List employees with a date in a period".
Inputs
- Fields
fieldslist - The HiBob fields to return, by field ID, such as root.email or work.department (List employee fields shows every ID). Leave blank for HiBob's standard set: the employee's name and email and the About, Employment and Work sections. A field your company added, such as a probation end date, only comes back when it is named here. HiBob leaves out, without an error, any field the connected service user may not view. At most 400.
- Only these employees
filterslist - Leave blank for every employee. To read particular employees, give one entry naming them by employee ID or by email, such as {"fieldPath": "root.email", "operator": "equals", "values": ["ana@example.com"]}. HiBob can match on root.id or root.email only, and only with equals: it cannot search by department, date or any other field. To find employees by a date, use "List employees with a date in a period".
- Include former employees
show_inactivetrue/false - Also return people who no longer work here (inactive in HiBob). Off by default, so only current employees come back. The connected service user also needs access to inactive employees in HiBob.Default:
false. - Readable values
human_readabletext - How to return what HiBob stores as a code, such as a department your company added (a list ID) or a manager (an employee ID). Leave blank for the stored values only. Add readable values also returns the names, under humanReadable on each employee. Readable values only returns every value as display text (dates in your company's format, the manager as a name without their email) and leaves out empty fields.One of:
APPEND(Add readable values),REPLACE(Readable values only).
Outputs
dataobject- Every employee that matched, in one answer: HiBob does not split it into pages.
Example output
{
"data": {
"employees": []
}
}Update employee
Change an employee's first name, surname or personal mobile number. Only what you fill in changes.
Inputs
- Employee
identifiertextRequired - The employee to change: pick one, or give their HiBob employee ID.
- First name
first_nametext - The employee's new first name.
- Surname
surnametext - The employee's new surname.
- Mobile phone
mobile_phonetext - The employee's new personal mobile number.
Outputs
dataobject- Data.
Example output
{
"data": {}
}