Skip to main content
HiBob logo
  • Category: human resources
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 208
  • Triggers: 0
  • Slug: HIBOB
  • Version: 20261101_00

Tools

Slug: HIBOB_ARCHIVE_PROJECTArchive an attendance project.

Input Parameters

integer
required
Project ID to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_ARCHIVE_PROJECT_TASKArchive a project task.

Input Parameters

integer
required
Task ID to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_ARCHIVE_SKILLSBulk-archive API-origin skills by source and externalId locator. Results report per-item success or failure, including when all items fail.

Input Parameters

array
required
Skills to archive. Each item must contain exact /skill/source and /skill/externalId locator keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_ARCHIVE_TRAINING_CONTENTMark one or more LMS training content items as archived.

Input Parameters

array
required
External identifiers of training content to archive.
string
required
Provider identifier of the LMS integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_BULK_CREATE_ATTENDANCE_ENTRIESCreate one or more duration or start-end attendance entries.

Input Parameters

array
required
One to 100 attendance entries to create.
object
Optional provider request metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_BULK_UPDATE_ATTENDANCE_ENTRIESUpdate one or more attendance entries for a specific employee.

Input Parameters

array
required
One to 100 duration or start-end attendance entry updates.
string
required
Employee whose entries are being updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CANCEL_POSITIONImmediately cancel one workforce-planning position.

Input Parameters

integer
required
Position ID to cancel immediately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CANCEL_TIME_OFF_REQUESTCancel an employee’s time off request.

Input Parameters

string
required
Employee ID that owns the request.
integer
required
Time off request ID to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CLOCK_IN_EMPLOYEECreate an attendance entry by clocking in an employee.

Input Parameters

integer
Optional project task ID.
string
Optional comment.
string ("work" | "break")
Entry type; defaults to work.
integer
Optional project ID.
string
required
Employee ID to clock in.
string
Optional ID from the timeLogEntryReason company list.
string
required
Current-date clock-in timestamp in ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CLOCK_OUT_EMPLOYEERecord clock-out for an employee with an open clock-in.

Input Parameters

string
required
Employee ID to clock out.
string
required
Current-date clock-out timestamp in ISO 8601 format; an open clock-in must exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_COMPLETE_TASKMarks a task as complete.

Input Parameters

string
required
ID of the task to mark complete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_COMPANY_EMPLOYEEThis endpoint allows you to create a new employee in the system.

Input Parameters

object
required
Initial employment details, including site and start date.
string
required
Employee’s email address. Must be a valid email address, unique within the company
string
required
Employee’s surname. Max length: 50, can only contain letters and ´̀_-;,̩./’’”()`
string
required
Employee’s first name. Max length: 50, can only contain letters and ´̀_-;,̩./’’”()`

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_CUSTOM_TABLE_ENTRYCreate an entry in an employee’s custom table from column-value pairs.

Input Parameters

array
Column-value objects for the new custom-table entry.
string
required
Employee ID.
string
required
The ID of custom table.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_EMPLOYEE_BANK_ACCOUNTCreate a new bank account entry for a given employee.

Input Parameters

string
required
The ID of the employee for whom you want to add the bank account entry. The employee ID is returned in the ‘id’ field when retrieving an employee’s data. For testing purposes you can obtain the Employee ID from the URL in the user interface.
string
The international bank account number (IBAN) for international transfers.
number
Use this field to provide the values that correspond to the ‘allocation’ field. If allocation is ‘percent’ this value represents the percentage of the salary portion to allocate. If allocation is ‘amount’ this value represents the fixed amount of the salary portion to allocate. If allocation is ‘remaining’ then the amount field should remain empty. This indicates that all of the remaining funds will be allocated to this account.
string
The name of the specific financial institution.
string ("percent" | "amount" | "remaining")
The salary portion allocated for this account. It can be defined as a percentage of the salary, as a fixed amount, or to allocate all of the remaining funds. The list of possible values cannot be modified. The values that correspond to this field should be provided in the ‘amount’ field.
string
The SWIFT Address assigned to the bank in order to send automated international transfers.
boolean
An indication whether this bank account is used for bonuses.
string
The account number is the unique identifier at this bank.
string
The bank’s address.
string
The routing number indicates what bank this account is held in. Relevant for US and Canada.
string
The nickname in Bob to easily identify and personalize this account in Online Banking.
string ("Checking" | "Savings")
The list of bank accounts type comes with the above out-of-the-box values. To obtain additional user-defined values, you should fetch the list values call the Get all company lists Metadata API with bankaccounttype in the listname path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_EMPLOYEE_DEDUCTIONCreates a new deduction table entry for the employee.

Input Parameters

string
required
Employee ID.
object
required
Deduction amount with a numeric value and three-letter currency code.
string
Optional explicit end date for this deduction period (ISO 8601 date).
string
required
Deduction type name from the company deduction type list (for example Childcare vouchers or Health insurance). To list available values, call the Get company list by name endpoint with list name deductionType.
object
Custom column values for this entry, keyed by column id.
string
required
Start of this timeline step (ISO 8601 date). Together with deduction, forms a unique key per employee for each row.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_EMPLOYEE_DEPENDENTCreates a new dependent entry for the employee.

Input Parameters

string
required
Employee ID.
string
Dependent’s gender value as stored in Bob.
string
Dependent’s surname / last name.
string
Dependent’s date of birth (ISO 8601 date).
string
Dependent’s first name.
object
Custom column values for this entry, keyed by column id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_EMPLOYEE_EMPLOYMENT_HISTORYCreates a new employment entry for a given employee.

Input Parameters

string
required
employee id
object
required
Employment entry to add. This must not conflict with another entry on the same effective date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_EMPLOYEE_ENTITLEMENTCreates a new entitlement table entry for the employee.

Input Parameters

string
required
Employee ID.
object
required
Entitlement amount with a numeric value and three-letter currency code.
string
Optional explicit end date for this entitlement period (ISO 8601 date).
string
required
Entitlement type name from the company entitlement type list (for example Lunch vouchers or Company Car). To list available values, call the Get company list by name endpoint with list name entitlementType.
object
Custom column values for this entry, keyed by column id.
string
required
Start of this timeline step (ISO 8601 date).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_EMPLOYEE_EQUITY_GRANTCreates a new equity grant for a given employee.

Input Parameters

string
required
Employee ID.
object
required
Equity grant to add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_EMPLOYEE_FIELDCreates a new company employee field.

Input Parameters

string
required
The name of the field.
string ("text" | "text-area" | "number" | "date" | "list" | "multi-list" | "hierarchy-list" | "currency" | "employee-reference" | "document")
required
The type of field. Supported field types: text, text-area, number, date, list, multi-list, hierarchy-list, currency, employee-reference, document.
string
required
The category of the field.
boolean
When true, this field keeps the history of its values, each being active starting from a certain date. The default value is false.
string
The description of the field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_EMPLOYEE_RIGHT_TO_WORKCreates a new right to work entry for the employee.

Input Parameters

string
required
Employee ID.
string
Right to work document type (list value as stored in Bob).
string
Document or permit number.
string
Issuing authority.
string
Date from which the document is valid (ISO 8601 date).
number
ID of the document attached to this entry. Upload files via the Docs API and reference the returned document id here.
object
Custom column values for this entry, keyed by column id.
string
Document expiration date (ISO 8601 date).
string
Application date (ISO 8601 date).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_EMPLOYEE_SALARY_HISTORYCreates a new salary entry for a given employee.

Input Parameters

string
required
Employee backend-id.
object
required
Salary entry to add. This must not conflict with another entry on the same effective date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_EMPLOYEE_TRAINING_RECORDCreate a new training record in the Training table.

Input Parameters

string
required
Employee ID.
object
required
Values for the Training entry you want to add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_EMPLOYEE_VARIABLE_PAYMENTCreates a new variable pay entry for the employee.

Input Parameters

string
required
Employee ID.
object
required
Payment amount with a numeric value and three-letter currency code.
string
The reason for this change.
string
required
The type of variable pay. Default values include Bonus, ExecutiveBonus, and Commission. Companies may add custom list values.
object
Custom column values for this entry, keyed by column id.
string
required
The date this entry becomes effective (ISO 8601 date).
string ("Annual" | "Half-Yearly" | "Quarterly" | "Monthly")
required
The payment period for this variable entry. Possible values: Annual, Half-Yearly, Quarterly, Monthly.
number
The employee’s company on-target weight, in percentage.
number
The employee’s department on-target weight, in percentage.
number
The employee’s individual on-target weight, in percentage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_EMPLOYEE_WORK_HISTORYCreate a new work entry for a given employee.

Input Parameters

string
required
Employee ID.
object
required
Work entry to add. This must not conflict with another entry on the same effective date and site.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_GOALSCreates up to 25 goals in HiBob.

Input Parameters

array
required
Up to 25 goals to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_INTEGRATIONCreate an LMS provider integration in Bob.

Input Parameters

string
Display name. When omitted or blank, Bob derives it from the provider identifier.
string
required
Stable provider key for the LMS integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_KEY_RESULTSCreates up to 25 key results for an existing goal.

Input Parameters

array
required
Up to 25 key results to create.
integer
required
ID of the goal that will own the key results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_NAMED_LIST_ITEMAdd a new item to an existing list.

Input Parameters

string
required
Name of the item.
string
required
The internal name of the list.
integer
ID of the new hierarchy parent node.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_POSITIONCreate workforce-planning positions with their required opening and optional budget.

Input Parameters

array
required
Up to ten positions to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_POSITION_BUDGETCreate a budget for a workforce-planning position.

Input Parameters

array
required
At most one position budget to create.
integer
required
Position ID to attach the budget to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_POSITION_OPENINGCreate one or more openings for a workforce-planning position.

Input Parameters

array
required
Up to ten position openings to create.
integer
required
Position ID to add openings to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_PROJECTSCreate one or more attendance projects.

Input Parameters

array
required
One to 100 projects to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_PROJECT_TASKSCreate one or more attendance project tasks.

Input Parameters

array
required
One to 100 tasks to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_SKILLSBulk-create API-origin skills with per-item results.

Input Parameters

array
required
Skills to create. Each item uses exact documented keys including /skill/name, /skill/source, and /skill/externalId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_TIME_OFF_BALANCE_ADJUSTMENTAdd a manual balance or time-used adjustment for an employee.

Input Parameters

string
required
Employee ID whose balance will be adjusted.
number
Days or hours to add or subtract.
string
Reason for the adjustment.
string
Policy type name.
string
Effective date in YYYY-MM-DD format.
string ("balance" | "daysUsed")
Adjustment type: balance or time used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_TIME_OFF_REASON_CODESCreate reason codes for a configured time off policy type.

Input Parameters

string
required
Policy type name.
array
Reason code display names to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_TIME_OFF_REQUESTSubmit a time off request for an employee using one documented duration shape.

Input Parameters

string
required
Employee ID receiving the time off request.
string
required
Provider-documented time off request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_CREATE_TRAINING_CONTENTCreate up to 500 training content items for an LMS integration.

Input Parameters

array
required
Training content rows keyed by documented field paths. Each row requires non-blank /trainingContent/externalIdentifier and /trainingContent/title; supported optional keys are /trainingContent/description, /trainingContent/sourceLink, /trainingContent/thumbnail, /trainingContent/duration, /trainingContent/language, /trainingContent/category, /trainingContent/learningGoals, /trainingContent/publishDate, /trainingContent/createdAt, and /trainingContent/intendedFor.
string
required
Provider identifier of the LMS integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_ATTENDANCE_ENTRYPermanently delete an attendance entry by ID.

Input Parameters

integer
required
Attendance entry ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_CONFIDENTIAL_DOCUMENTDelete a document from an employee’s confidential folder.

Input Parameters

string
required
Employee ID that owns the document.
string
required
Document ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_CUSTOM_FOLDER_DOCUMENTDelete a document from an employee’s custom folder.

Input Parameters

string
required
Employee ID that owns the document.
string
required
Document ID to delete.
string
required
Custom folder ID containing the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_CUSTOM_TABLE_ENTRYDelete custom table entry.

Input Parameters

string
required
The ID of custom table entry.
string
required
Employee ID.
string
required
The ID of custom table.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_EMPLOYEE_BANK_ACCOUNTDeletes a bank account entry from a given employee’s bank accounts table.

Input Parameters

string
required
The ID of the employee for whom you want to delete the bank account entry. The employee ID is returned in the ‘id’ field when retrieving an employee’s data. For testing purposes you can obtain the Employee ID from the URL in the user interface.
integer
required
The ID of the entry in the bank accounts table which you want to delete. To obtain the bank account entry use the GET /people/{id}/bank-accounts endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_EMPLOYEE_DEDUCTIONDeletes a deduction entry for the given employee.

Input Parameters

string
required
Employee ID.
integer
required
The entry ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_EMPLOYEE_DEPENDENTDeletes a dependent entry for the given employee.

Input Parameters

string
required
Employee ID.
integer
required
The entry ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_EMPLOYEE_EMPLOYMENT_HISTORYDeletes an employment entry from a given employee’s employment history.

Input Parameters

string
required
Employee ID.
integer
required
The entry ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_EMPLOYEE_ENTITLEMENTDeletes an entitlement entry for the given employee.

Input Parameters

string
required
Employee ID.
integer
required
The entry ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_EMPLOYEE_EQUITY_GRANTDeletes an equity grant for an employee.

Input Parameters

string
required
Employee ID.
integer
required
The Entry ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_EMPLOYEE_FIELDDeletes an existing company employee field.

Input Parameters

string
required
The ID of the field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_EMPLOYEE_RIGHT_TO_WORKDeletes a right to work entry for the given employee.

Input Parameters

string
required
Employee ID.
integer
required
The entry ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_EMPLOYEE_SALARY_HISTORYDeletes a salary entry from the employee’s list.

Input Parameters

string
required
Employee ID.
integer
required
The entry ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_EMPLOYEE_TRAINING_RECORDDeletes a specified training record for an employee.

Input Parameters

string
required
Employee ID.
integer
required
The Entry ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_EMPLOYEE_VARIABLE_PAYMENTDeletes a variable pay entry for the given employee.

Input Parameters

string
required
Employee ID.
integer
required
The Entry ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_EMPLOYEE_WORK_HISTORYDeletes a work entry from a given employee’s work history.

Input Parameters

string
required
Employee ID.
integer
required
The entry ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_GOALPermanently deletes a goal by ID.

Input Parameters

integer
required
ID of the goal to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_KEY_RESULTPermanently deletes a key result from a goal.

Input Parameters

integer
required
ID of the goal containing the key result.
integer
required
ID of the key result to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_LMS_INTEGRATIONDelete an LMS provider integration from Bob.

Input Parameters

string
required
Provider identifier of the LMS integration to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_NAMED_LIST_ITEMDelete an item from an existing list.

Input Parameters

string
required
The ID of the list item.
string
required
The internal name of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_POSITION_OPENINGDelete an opening from a workforce-planning position.

Input Parameters

integer
required
Position ID that owns the opening.
integer
required
Position-opening ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DELETE_SHARED_DOCUMENTDelete a document from an employee’s shared folder.

Input Parameters

string
required
Employee ID that owns the document.
string
required
Document ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DOWNLOAD_REPORT_BY_IDReturns a report data file in the specified format.

Input Parameters

string ("csv" | "xlsx" | "json")
required
File format. HiBob requires this query parameter; use csv for the documented default.
string
Locale for report columns, such as fr-FR.
integer
required
ID of the report to download, from the company reports response.
boolean
Whether to include report information.
string
For JSON reports, APPEND or REPLACE human-readable values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_DOWNLOAD_REPORT_BY_NAMEDownloads a report generated by the asynchronous report endpoint. A 204 response means the file is not ready and is returned as an execution failure so no empty file is emitted.

Input Parameters

string
required
Report name returned in the asynchronous report Location URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_AVATAR_BY_EMAILReturns the employee’s avatar image URL without fetching the image.

Input Parameters

string
required
Email address of the employee whose avatar URL should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_AVATAR_BY_EMPLOYEE_IDReturns the employee’s avatar image URL without fetching the image.

Input Parameters

string
required
The Employee ID as pulled from the database, or from the URL In Bob when viewing the employee. For example, if the URL in Bob is “https://app.hibob.com/employee-profile/3332883884017713238” you should copy the “3332883884017713238”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_CUSTOM_TABLE_METADATARead metadata for specific custom table.

Input Parameters

string
required
The ID of custom table.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_DOCUMENT_FOLDERS_METADATAList Bob document folders and their identifiers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_EMPLOYEE_TIME_OFF_BALANCERetrieve an employee’s balance for a policy type at a point in time.

Input Parameters

string
required
Employee ID whose balance will be retrieved.
string
required
Balance date in YYYY-MM-DD format.
string
required
Policy type name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_EMPLOYER_METADATAReturns the field catalog for the employer object — the set of fields a client can read, with their types, validations, and status.

Input Parameters

object
Field-selection options. When omitted, the action sends an empty selection object because HiBob rejects a missing fields object.
array
Object properties to fetch. When empty, only id is returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_GOAL_CYCLE_METADATAReturns metadata describing the fields available on goal cycles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_GOALS_METADATAReturns metadata describing the fields available on goals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_GOAL_TYPE_METADATAReturns metadata describing the fields available on goal types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_JOB_ADReturns details of a job ad promoted on the Bob careers page.

Input Parameters

string
required
Job-ad ID from the career-page URL or the job-ad search response.
string
Preferred language code for translated job-ad content, when available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_JOB_FAMILY_GROUP_METADATAReturns metadata describing job-family-group fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_JOB_FAMILY_METADATAReturns metadata describing job-family fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_JOB_PROFILES_METADATAReturns metadata describing job-profile fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_JOB_ROLE_METADATAReturns metadata describing job-role fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_KEY_RESULTS_METADATAReturns metadata describing the fields available on key results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_NAMED_LISTGet a specific company list by name.

Input Parameters

string
required
The internal name of the list.
boolean
By default (false), archived items are excluded from the response. When set to true, archived items are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_PERSONSingle-employee read endpoint (not bulk search): returns field data for one employee identified by backend ID or email in the path in a single response.

Input Parameters

array
Field IDs to return in dot notation, such as root.id or work.department. Use LIST_EMPLOYEE_FIELDS to discover IDs. Omit for the default field set. Unknown or unauthorized fields are silently omitted, and response keys use slash notation such as /root/id.
string
required
Employee ID or email address identifying the employee to return.
string ("APPEND" | "REPLACE")
Human-readable value mode. APPEND adds human-readable values; REPLACE returns them instead of machine-format values. Omit for machine-format values only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_POSITION_BUDGET_METADATAGet the field metadata for workforce-planning position budgets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_POSITION_METADATAGet the field metadata for workforce-planning positions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_POSITION_OPENING_METADATAGet the field metadata for workforce-planning position openings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_PROJECT_CLIENT_METADATAGet metadata describing available project client fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_PROJECT_METADATAGet metadata describing available attendance project fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_PROJECT_TASK_METADATAGet metadata describing available project task fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_TIME_OFF_POLICY_DETAILSRetrieve details of a named time off policy.

Input Parameters

string
required
Policy name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_TIME_OFF_POLICY_TYPERetrieve a configured time off policy type.

Input Parameters

string
required
Policy type name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_TIME_OFF_REQUESTRetrieve one employee time off request by ID.

Input Parameters

string
required
Employee ID that owns the request.
integer
required
Time off request ID.
boolean
Include duration details for each day.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_GET_WORK_LOCATION_METADATARetrieve the field catalog for the workLocation object, with selectable field properties such as types, validations, and status.

Input Parameters

object
Field-selection options. When omitted, the action sends an empty selection object because HiBob rejects a missing fields object.
array
Object properties to fetch. When empty, only id is returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_IMPORT_ATTENDANCE_DATAImport employee clock-in and clock-out events.

Input Parameters

string
required
Employee identifier type: bobId, email, idInCompany, or a custom field path.
array
required
Attendance events to import.
string ("aggregate" | "immediate")
required
Aggregate asynchronously or insert records immediately.
string
Optional custom format for event date-time values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_INVITE_EMPLOYEEInvite an employee to HiBob using an onboarding welcome wizard.

Input Parameters

string
required
Employee ID to invite. Retrieve it from an employee record or profile URL.
integer
required
The Welcome wizard ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_COMPANY_JOB_PROFILESSearches company job profiles and returns one page of matching profiles.

Input Parameters

array
required
One to 50 standard or custom job-profile field IDs to return, such as /jobProfile/field_123.
array
required
Job-profile filtering conditions.
object
Optional nested page size and continuation cursor.
boolean
Whether to include human-readable values alongside raw values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_COMPANY_LISTSGet all company lists.

Input Parameters

boolean
By default (false), archived items are excluded from the response. When set to true, archived items are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_COMPANY_REPORTSReturns a list of all company reports with their details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_CUSTOM_TABLE_ENTRIESRead entries of a specified employee’s custom table.

Input Parameters

string
required
Employee ID.
string
required
The ID of custom table.
boolean
Whether to include the additional “humanReadable” JSON node in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_CUSTOM_TABLES_METADATARead metadata of custom tables defined.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_BANK_ACCOUNTSReturns a list of the bank accounts table entries for a given employee.

Input Parameters

string
required
The ID of the employee for whom you want to fetch the bank account entries. The employee ID is returned in the ‘id’ field when retrieving an employee’s data. For testing purposes you can obtain the Employee ID from the URL in the user interface.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_DEDUCTION_RECORDSReturns deduction table entries for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

Input Parameters

integer
Specifies the number of table entries to include on each page of the results.
string
A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob’s API.
string
Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the People search endpoint.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_DEPENDENTS_RECORDSReturns dependent entries for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

Input Parameters

integer
Specifies the number of table entries to include on each page of the results.
string
A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob’s API.
string
Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the People search endpoint.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_DOCUMENTSReturn an employee’s documents with downloadable file references.

Input Parameters

string
required
Employee ID whose documents should be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_EMPLOYMENT_HISTORIESReturns a list of employment history entries for a given employee.

Input Parameters

string
required
employee id
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_EMPLOYMENT_RECORDSReturns a list of historical employment entries from the employment table for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

Input Parameters

integer
Specifies the number of table entries to include on each page of the results.
string
A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob’s API.
string
Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return history records for all the employees for which the service user has the permission for.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_ENTITLEMENT_RECORDSReturns entitlement table entries for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

Input Parameters

integer
Specifies the number of table entries to include on each page of the results.
string
A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob’s API.
string
Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the People search endpoint.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_EQUITIES_RECORDSReturns equity table entries for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

Input Parameters

integer
Specifies the number of table entries to include on each page of the results.
string
A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob’s API.
string
Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the People search endpoint.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_EQUITY_GRANTSReturns a list of equity grants for a given employee.

Input Parameters

string
required
Employee ID.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_FIELDSThis endpoint retrieves only metadata about the employee fields and includes all employee fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_LIFECYCLE_HISTORIESReturns a list of historical lifecycle entries from the lifecycle table for an employee.

Input Parameters

string
required
Employee backend-id.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_LIFECYCLE_RECORDSReturns a list of historical lifecycle entries from the lifecycle table for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

Input Parameters

integer
Specifies the number of table entries to include on each page of the results.
string
A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob’s API.
string
Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return history records for all the employees for which the service user has the permission for.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_PUBLIC_PROFILESReturns a predefined list of fields for all active employees the service user can access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_RIGHT_TO_WORK_RECORDSReturns right to work entries for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

Input Parameters

integer
Specifies the number of table entries to include on each page of the results.
string
A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob’s API.
string
Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the People search endpoint.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_SALARIES_RECORDSReturns a list of historical salary entries from the payroll table for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

Input Parameters

integer
Specifies the number of table entries to include on each page of the results.
string
A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob’s API.
string
Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return history records for all the employees for which the service user has the permission for.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_SALARY_HISTORIESReturns a list of historical salary entries from the salary table in the payroll section for an employee.

Input Parameters

string
required
Employee backend-id.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_TASKSReturns tasks for a specific employee, optionally filtered by status.

Input Parameters

string
required
Employee ID whose tasks should be returned.
string ("open" | "closed")
Filter by open or closed status; omit to return all tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_TRAINING_RECORDSReturns a list of training entries from the employee’s Training table, for a given employee.

Input Parameters

string
required
The identifier of the employee.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_VARIABLE_PAYMENTSReturns a list of variable payments for a given employee.

Input Parameters

string
required
Employee ID.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_VARIABLE_RECORDSReturns variable pay table entries for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

Input Parameters

integer
Specifies the number of table entries to include on each page of the results.
string
A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob’s API.
string
Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the People search endpoint.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_WORK_HISTORIESReturns a list of historical work entries from the work table for an employee.

Input Parameters

string
required
Employee backend-id.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_EMPLOYEE_WORK_RECORDSReturns a list of historical work entries from the work table for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

Input Parameters

integer
Specifies the number of table entries to include on each page of the results.
string
A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob’s API.
string
Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_JOB_FAMILIESReturns one page of job families from the company job catalog.

Input Parameters

integer
Maximum job families to return on this page (1-100).
string
Cursor returned by the previous page; omit for the first page.
boolean
Whether to include human-readable values alongside raw values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_JOB_FAMILY_GROUPSReturns one page of job-family groups from the company job catalog.

Input Parameters

integer
Maximum job-family groups to return on this page (1-100).
string
Cursor returned by the previous page; omit for the first page.
boolean
Whether to include human-readable values alongside raw values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_JOB_ROLESReturns one page of job roles from the company job catalog.

Input Parameters

integer
Maximum job roles to return on this page (1-100).
string
Cursor returned by the previous page; omit for the first page.
boolean
Whether to include human-readable values alongside raw values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_ONBOARDING_WIZARDSList onboarding welcome wizards and their IDs for inviting employees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_OPEN_TASKSReturns up to 5,000 open company tasks ordered by task ID. HiBob imposes this hard limit and provides no pagination, so companies with more than 5,000 open tasks receive an incomplete set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_PAYROLL_TABLES_HISTORYList legacy payroll-table history, optionally filtered by department and inactive employees; this provider endpoint is planned for deprecation.

Input Parameters

string
filter payroll for specific department.
boolean
When true, includes inactive (typically terminated) employees in payroll history results. Default is active employees only. For employee field search, use showInactive on POST /people/search instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_PEOPLE_OUT_OF_OFFICEList people with time off requests in an inclusive date range.

Input Parameters

string
required
End date in YYYY-MM-DD format.
string
required
Start date in YYYY-MM-DD format.
boolean
Include hourly requests.
boolean
Include pending requests.
boolean
Include private requests; requires additional permission.
boolean
Include requests for working policy types such as work from home.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_PEOPLE_OUT_TODAYList people who are out on a selected date.

Input Parameters

string
Date in YYYY-MM-DD format; defaults to today.
integer
Limit results to this site ID.
boolean
Include hourly requests.
boolean
Include private requests; requires additional permission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_PROFICIENCY_LEVELSLists the company’s proficiency levels referenced by skill create and update operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_TIME_OFF_POLICY_NAMESList policy names belonging to a time off policy type.

Input Parameters

string
required
Policy type name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_TIME_OFF_POLICY_TYPESList configured time off policy type names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_TIME_OFF_REASON_CODESList request reason codes configured for a policy type.

Input Parameters

string
required
Policy type name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_LIST_TIME_OFF_REQUEST_CHANGESList time off requests created, canceled, deleted, or pending since a point in time.

Input Parameters

string
Optional end timestamp or date for the changes window.
string
required
Start timestamp or date for the changes window.
boolean
Include pending requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_RESTORE_PROJECTRestore an archived attendance project.

Input Parameters

integer
required
Project ID to restore.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_RESTORE_PROJECT_TASKRestore an archived project task.

Input Parameters

integer
required
Task ID to restore.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_REVOKE_EMPLOYEE_ACCESSRevoke an employee’s access to HiBob without deleting the employee record.

Input Parameters

string
required
Employee ID whose access to HiBob will be revoked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SCHEDULE_POSITION_CANCELLATIONCancel multiple positions immediately or on a specified date.

Input Parameters

array
required
Position IDs to cancel.
string
Cancellation date in YYYY-MM-DD format; omit to cancel immediately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_ACTUAL_PAYMENTSThis endpoint allows you to search for actual payments based on various filters. Returns one page and a continuation cursor when available.

Input Parameters

string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.
array
required
An array of filter criteria, each containing a field ID, operator, and values. Supported fields for filtering are: employeeId (required): Filter by the the employee ID. All queries must specify the employee Ids to fetch. Each call can retrieve up to 200 employees. payDate (optional): Filter by the date of the pay period. Important: The array must include a filter for employeeId, as it is required for all requests. The structure of the filters may vary slightly depending on the field being used.
object
Optional pagination parameters.
boolean
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_APPLICATION_FORM_ANSWERSSearches application form answer records using filters and returns one page of results.

Input Parameters

integer
Maximum records to return on this page (1-200).
string
Continuation cursor from the previous page; omit for the first page.
array
required
Field IDs to return, chosen from the documented /applicationFormAnswer fields.
array
Filters to apply to application form answers.
boolean
Whether to include archived records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_APPLICATIONSSearches applications using filters and returns one page of results.

Input Parameters

integer
Maximum records to return on this page (1-200).
string
Continuation cursor from the previous page; omit for the first page.
array
required
Field IDs to return, chosen from the documented /application fields.
array
Filters to apply to applications.
boolean
Whether to include archived applications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_ATTENDANCE_ENTRIESRetrieve one page of attendance entries for employees and dates.

Input Parameters

integer
Maximum items per page.
string
Continuation cursor from the previous page.
array
required
Attendance entry field IDs to return.
array
required
Employee ID and clock-in date filters.
boolean
Whether to include human-readable values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_ATTENDANCE_SUMMARIESRetrieve one page of attendance summaries by employee and date range.

Input Parameters

integer
Maximum items per page.
string
Continuation cursor from the previous page.
array
required
Required summary field IDs to return; include /attendanceSummary/employeeId.
array
required
Exactly dateRange and employeeId filters.
boolean
Whether to include human-readable values; currently unsupported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_CALENDAR_EVENTSSearch holiday and company-closure calendar events for an inclusive date range.

Input Parameters

integer
Page size (1-500).
string
Cursor from the previous page.
array
Calendar-event field IDs to return; omit for all fields.
array
required
Filters including startDate from/to filters spanning at most 366 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_CANDIDATE_EDUCATIONSSearches candidate education records and returns one page.

Input Parameters

integer
Maximum records on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /candidateEducation field IDs to return.
array
Filters to apply to education records.
boolean
Whether to include archived records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_CANDIDATE_EXPERIENCESSearches candidate work experience records and returns one page.

Input Parameters

integer
Maximum records on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /candidateExperience field IDs to return.
array
Filters to apply to experience records.
boolean
Whether to include archived records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_CANDIDATE_LANGUAGESSearches candidate language records and returns one page.

Input Parameters

integer
Maximum records on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /candidateLanguage field IDs to return.
array
Filters to apply to language records.
boolean
Whether to include archived records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_CANDIDATE_PROFESSIONAL_ASSOCIATIONS_MEMBERSHIPSSearches candidate professional association membership records and returns one page.

Input Parameters

integer
Maximum records on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /candidateProfessionalAssociationsMemberships field IDs to return.
array
Filters to apply to membership records.
boolean
Whether to include archived records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_CANDIDATE_QUALIFICATIONS_LICENSESSearches candidate qualification and license records and returns one page.

Input Parameters

integer
Maximum records on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /candidateQualificationsLicenses field IDs to return.
array
Filters to apply to qualification and license records.
boolean
Whether to include archived records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_CANDIDATESSearches candidates using filters and returns one page of results.

Input Parameters

integer
Maximum candidates on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /candidate field IDs to return.
array
Filters to apply to candidates.
boolean
Whether to include archived candidates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_CANDIDATE_SKILLSSearches candidate skill records and returns one page.

Input Parameters

integer
Maximum records on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /candidateSkills field IDs to return.
array
Filters to apply to skill records.
boolean
Whether to include archived records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_CANDIDATE_VOLUNTEER_EXPERIENCESSearches candidate volunteer experience records and returns one page.

Input Parameters

integer
Maximum records on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /candidateVolunteerExperience field IDs to return.
array
Filters to apply to volunteer experience records.
boolean
Whether to include archived records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_DAILY_ATTENDANCE_BREAKDOWNRetrieve one page of daily attendance breakdown data for employees using exactly three date or employee ID filters.

Input Parameters

integer
Maximum items per page.
string
Continuation cursor from the previous page.
array
required
Required field IDs to return; include /dailyBreakdown/employeeId and /dailyBreakdown/date. Custom field IDs are supported.
array
required
Exactly three filters: date from, date to, and employeeId equals.
boolean
Whether to include human-readable values; currently unsupported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_EMPLOYEE_CALENDARSResolve holiday calendars for employees and return one page of results.

Input Parameters

integer
Page size (1-1000).
string
Cursor from the previous page.
array
Employee-calendar field IDs to return; omit for all fields.
array
required
Filters, including exactly one employeeId filter with at most 5000 IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_EMPLOYERSSearches employers in the caller’s company. Returns one page and a continuation cursor when available.

Input Parameters

integer
Maximum number of items per page (allowed range 1–200). Defaults to 50.
string
Opaque cursor from a previous response’s response_metadata.next_cursor. Omit on the first request.
array
Field IDs to include in each result item. When omitted, all available fields are returned. Discover the authoritative field catalog (including custom fields) via the employer metadata search endpoint; out-of-the-box field IDs are also listed as keys on the Employer response schema.
array
required
Filters to apply. An empty list returns every employer the caller has permission to view.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_EVALUATIONSSearches evaluation records and returns one page.

Input Parameters

integer
Maximum evaluations on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /evaluation field IDs to return.
array
Filters to apply to evaluations.
boolean
Whether to include archived evaluations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_EVALUATION_SCORECARD_TEMPLATESSearches evaluation scorecard templates and returns one page.

Input Parameters

integer
Maximum templates on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /evaluationScorecardTemplate field IDs to return.
array
Filters to apply to scorecard templates.
boolean
Whether to include archived templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_GOAL_CYCLESSearches goal cycles and returns one page of matching records.

Input Parameters

integer
Number of items to return on this page.
string
Cursor returned by the previous page; omit for the first page.
array
required
Field IDs to include. Use goal-cycle metadata to discover valid IDs.
array
Filters; currently must be empty or omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_GOALSSearches goals and returns one page of matching records.

Input Parameters

integer
Maximum results requested; currently accepted but not enforced by HiBob.
string
Cursor returned by the previous page; currently accepted but not enforced by HiBob.
array
required
Field IDs to include. Use goal metadata to discover valid IDs.
array
Filters to apply; omit or use an empty list for all goals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_GOAL_TYPESSearches goal types and returns one page of matching records.

Input Parameters

integer
Maximum results requested; currently accepted but not enforced by HiBob.
string
Cursor returned by the previous page; currently accepted but not enforced by HiBob.
array
required
Field IDs to include. Use goal-type metadata to discover valid IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_INTERVIEWSSearches interview records and returns one page.

Input Parameters

integer
Maximum interviews on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /interview field IDs to return.
array
Filters to apply to interviews.
boolean
Whether to include archived interviews.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_JOB_ADSReturns active job ads promoted on the Bob career page.

Input Parameters

array
required
Documented /jobAd field IDs to return for each active job ad.
array
required
Required filters array for active job ads; use an empty list to return all active ads.
string
Preferred language code for translated job-ad content, when available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_JOB_OPENINGSSearches job openings using filters and returns one page.

Input Parameters

integer
Maximum job openings on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /jobOpening field IDs to return.
array
Filters to apply to job openings.
boolean
Whether to include archived job openings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_KEY_RESULTSSearches key results for a goal and returns one page.

Input Parameters

integer
Maximum results requested; currently accepted but not enforced by HiBob.
string
Cursor returned by the previous page; currently accepted but not enforced by HiBob.
array
required
Field IDs to include. Use key-result metadata to discover valid IDs.
array
required
Filters to apply; a goalId filter is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_OFFERSSearches offer records and returns one page.

Input Parameters

integer
Maximum offers on this page (1-200).
string
Continuation cursor; omit for the first page.
array
required
Documented /offer field IDs to return.
array
Filters to apply to offers.
boolean
Whether to include archived offers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_PEOPLESearch employee fields for many employees in one call, optionally filtering by employee ID or email using equality.

Input Parameters

array
Field IDs to return in dot notation, such as root.id. Use LIST_EMPLOYEE_FIELDS to discover IDs. Omit for the default field set; at most 400 are accepted.
array
Optional single filter on root.id or root.email using the equals operator. Omit when not filtering.
boolean
Whether to include inactive, typically terminated or former, employees. Defaults to false for active employees only.
string ("APPEND" | "REPLACE")
Human-readable value mode. APPEND adds human-readable values; REPLACE returns them instead of machine-format values. Omit for machine-format values only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_POSITION_BUDGETSSearch workforce-planning position budgets and return one page. Filters compare position-budget IDs using equals or notEqual.

Input Parameters

string
Continuation cursor from the preceding page; omit for the first page.
array
required
Position-budget field IDs to return.
array
required
Budget filtering conditions.
object
Nested HiBob pagination options.
boolean
Include human-readable values with raw values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_POSITION_OPENINGSReturn one page of workforce-planning position openings.

Input Parameters

string
Continuation cursor from the preceding page; omit for the first page.
array
required
Position-opening field IDs to return.
array
required
Opening filtering conditions.
object
Nested HiBob pagination options.
boolean
Include human-readable values with raw values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_POSITIONSSearch workforce-planning positions using documented field filters.

Input Parameters

array
required
Position field IDs to return; use metadata to discover custom IDs.
array
required
Position filtering conditions.
boolean
Include human-readable values with raw values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_PROJECT_CLIENTSSearch project clients and return one page of results.

Input Parameters

integer
Requested page size; currently ignored.
string
Continuation cursor; currently ignored by HiBob.
array
Project client field IDs to return.
array
Optional project client filters.
boolean
Include human-readable field values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_PROJECTSSearch attendance projects and return one page of results. By default, the search filters for active projects.

Input Parameters

integer
Requested page size; currently ignored.
string
Continuation cursor; currently ignored by HiBob.
array
Project field IDs to return; custom field IDs are supported.
array
Project filters.
boolean
Include human-readable field values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_PROJECT_TASKSSearch attendance project tasks and return one page of results.

Input Parameters

integer
Requested page size; currently ignored.
string
Continuation cursor; currently ignored by HiBob.
array
Task field IDs to return.
array
Optional task filters.
boolean
Include human-readable field values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_SKILLSSearches API-origin skills with field projection, filters, and one-page cursor pagination.

Input Parameters

integer
Maximum results on this page (1-200).
string
Opaque continuation cursor; omit for the first page.
array
Field IDs to include; empty returns the default field set.
array
Equals filters; empty returns all API-origin skills.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SEARCH_WORK_LOCATIONSSearches the work locations of a single employer, identified by the path parameter {employerId}. Returns one page and a continuation cursor when available.

Input Parameters

integer
Maximum number of items per page (allowed range 1–200). Defaults to 50.
string
Opaque cursor from a previous response’s response_metadata.next_cursor. Omit on the first request.
array
Field IDs to include in each result item. When omitted, all available fields are returned. Discover the authoritative field catalog (including custom fields) via the work-location metadata search endpoint; out-of-the-box field IDs are also listed as keys on the WorkLocation response schema.
array
required
Filters to apply within the employer’s work locations. An empty list returns every work location of the employer the caller has permission to view.
string
required
Identifier of the parent employer whose work locations to search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SET_EMPLOYEE_START_DATESet or change an employee’s employment start date, with an optional reason.

Input Parameters

string
Additional info for the start date update.
string
required
The date this entry becomes effective.
string
required
Employee ID whose employment start date will be set or changed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_START_REPORT_GENERATIONAsynchronously generates a report. HiBob returns 202 while generation starts and 200 with the generated report URL in the Location response header.

Input Parameters

string ("csv" | "xlsx")
required
File format to generate. HiBob requires this query parameter; use csv for the documented default.
string
Locale for report columns, such as fr-FR.
integer
required
ID of the report to generate, from the company reports response.
boolean
Whether to include report information.
string
Human-readable value mode when supported by HiBob.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_SUBMIT_X_API_STATEMENTSubmit one xAPI statement to record learner progress for a course.

Input Parameters

string
Optional statement UUID.
object
required
Action performed by the learner.
object
required
Learner who performed the activity.
object
required
Learning activity acted upon.
object
Optional activity result.
string
required
Statement timestamp in an ISO format accepted by Bob.
string
required
Provider identifier of the LMS integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_TERMINATE_COMPANY_EMPLOYEEThis changes the employee’s status to Terminated according to specified termination date.

Input Parameters

string
required
Employee ID to terminate.
string
The ID of the ‘lifecycleReasonType’ list entry
object
Notice period length
string
Employee’s final working date, when different from the termination date.
string
required
The employee’s termination date
string
The ID of the ‘terminationReason’ list entry

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_COMPANY_EMPLOYEEThis endpoint allows you to update specific fields in an employee’s record in Bob.

Input Parameters

object
required
Employee field values to update. Use LIST_EMPLOYEE_FIELDS to discover available field definitions.
string
required
Employee ID whose record will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_CUSTOM_TABLE_ENTRYUpdate an employee’s custom-table entry from column-value pairs.

Input Parameters

object
required
The documented JSON request body.
string
required
The ID of custom table entry.
string
required
Employee ID.
string
required
The ID of custom table.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_EMPLOYEE_AVATARUpload an employee’s Avatar by providing a URL to the image to upload.

Input Parameters

string
required
The URL of the source of the avatar image.
string
required
Employee ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_EMPLOYEE_BANK_ACCOUNTThis endpoint updates an entry in the employee’s Bank accounts table.

Input Parameters

string
required
The ID of the employee for whom you want to update the bank account entry. The employee ID is returned in the ‘id’ field when retrieving an employee’s data. For testing purposes you can obtain the Employee ID from the URL in the user interface.
string
The international bank account number (IBAN) for international transfers.
number
Use this field to provide the values that correspond to the ‘allocation’ field. If allocation is ‘percent’ this value represents the percentage of the salary portion to allocate. If allocation is ‘amount’ this value represents the fixed amount of the salary portion to allocate. If allocation is ‘remaining’ then the amount field should remain empty. This indicates that all of the remaining funds will be allocated to this account.
integer
required
The ID of the entry in the bank accounts table which you are updating. To obtain the bank account entry use the GET /people/{id}/bank-accounts endpoint.
string
The name of the specific financial institution.
string ("percent" | "amount" | "remaining")
The salary portion allocated for this account. It can be defined as a percentage of the salary, as a fixed amount, or to allocate all of the remaining funds. The list of possible values cannot be modified. The values that correspond to this field should be provided in the ‘amount’ field.
string
The SWIFT Address assigned to the bank in order to send automated international transfers.
boolean
An indication whether this bank account is used for bonuses.
string
The account number is the unique identifier at this bank.
string
The bank’s address.
string
The routing number indicates what bank this account is held in. Relevant for US and Canada.
string
The nickname in Bob to easily identify and personalize this account in Online Banking.
string ("Checking" | "Savings")
The list of bank accounts type comes with the above out-of-the-box values. To obtain additional user-defined values, you should fetch the list values call the Get all company lists Metadata API with bankaccounttype in the listname path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_EMPLOYEE_DEDUCTIONUpdates an existing deduction entry for the given employee.

Input Parameters

string
required
Employee ID.
object
required
Deduction amount with a numeric value and three-letter currency code.
string
Optional explicit end date for this deduction period (ISO 8601 date).
integer
required
The entry ID to update.
string
required
Deduction type name from the company deduction type list (for example Childcare vouchers or Health insurance). To list available values, call the Get company list by name endpoint with list name deductionType.
object
Custom column values for this entry, keyed by column id.
string
required
Start of this timeline step (ISO 8601 date). Together with deduction, forms a unique key per employee for each row.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_EMPLOYEE_DEPENDENTUpdates an existing dependent entry for the given employee.

Input Parameters

string
required
Employee ID.
object
required
Values for the dependent entry you want to update.
integer
required
The entry ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_EMPLOYEE_EMAILChange an employee’s email address.

Input Parameters

string
required
employee id
string
new email

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_EMPLOYEE_EMPLOYMENT_HISTORYThis endpoint updates an entry in the employee’s employment history table.

Input Parameters

string
required
Employee ID.
object
required
The documented JSON request body.
integer
required
The entry ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_EMPLOYEE_ENTITLEMENTUpdates an existing entitlement entry for the given employee.

Input Parameters

string
required
Employee ID.
object
required
Entitlement amount with a numeric value and three-letter currency code.
string
Optional explicit end date for this entitlement period (ISO 8601 date).
integer
required
The entry ID to update.
string
required
Entitlement type name from the company entitlement type list (for example Lunch vouchers or Company Car). To list available values, call the Get company list by name endpoint with list name entitlementType.
object
Custom column values for this entry, keyed by column id.
string
required
Start of this timeline step (ISO 8601 date).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_EMPLOYEE_EQUITY_GRANTThis endpoint updates an entry in the employee’s equity table.

Input Parameters

string
required
Employee ID
object
required
The documented JSON request body.
integer
required
The entry ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_EMPLOYEE_FIELDUpdates an existing company employee field.

Input Parameters

string
The name of the field.
string
required
The ID of the field.
string
The description of the field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_EMPLOYEE_RIGHT_TO_WORKUpdates an existing right to work entry for the given employee.

Input Parameters

string
required
Employee ID.
object
required
Values for the right to work entry you want to update.
integer
required
The entry ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_EMPLOYEE_VARIABLE_PAYMENTUpdates an existing variable pay entry for the given employee.

Input Parameters

string
required
Employee ID.
object
required
Payment amount with a numeric value and three-letter currency code.
string
The reason for this change.
integer
required
The entry ID to update.
string
required
The type of variable pay. Default values include Bonus, ExecutiveBonus, and Commission. Companies may add custom list values.
object
Custom column values for this entry, keyed by column id.
string
required
The date this entry becomes effective (ISO 8601 date).
string ("Annual" | "Half-Yearly" | "Quarterly" | "Monthly")
required
The payment period for this variable entry. Possible values: Annual, Half-Yearly, Quarterly, Monthly.
number
The employee’s company on-target weight, in percentage.
number
The employee’s department on-target weight, in percentage.
number
The employee’s individual on-target weight, in percentage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_EMPLOYEE_WORK_HISTORYThis endpoint updates an entry in the employee’s work history table.

Input Parameters

string
required
The ID of the employee you are updating. This can be the Employee ID from the URL in the user interface or the id field returned when retrieving an employee’s data.
object
required
The documented JSON request body.
integer
required
The ID of the entry in the work table which you are updating. To obtain the work entry use the GET /people/{id}/work endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_GOALUpdates details of an existing goal.

Input Parameters

array
required
Single goal update item.
integer
required
ID of the goal to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_GOAL_STATUSUpdates the status of an existing goal and optionally records a comment.

Input Parameters

integer
required
ID of the goal whose status will change.
string ("onTrack" | "offTrack" | "completed" | "incomplete" | "other")
required
New goal status.
string
Optional comment for the status update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_KEY_RESULTS_DETAILSUpdates details of one or more key results on a goal.

Input Parameters

array
required
Key results to update.
integer
required
ID of the goal containing the key results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_KEY_RESULTS_PROGRESSRecords progress values and optional check-in notes for key results.

Input Parameters

integer
required
ID of the goal containing the key results.
string
Optional goal-level check-in comment stored in the activity log.
array
Key-result progress updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_NAMED_LIST_ITEMUpdate an existing item from a list.

Input Parameters

string
Name of the item.
string
required
The ID of the list item.
string
required
The internal name of the list.
integer
ID of the new hierarchy parent node.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_POSITIONUpdate the mutable fields of one workforce-planning position.

Input Parameters

array
required
At most one position update item.
integer
required
Position ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_POSITION_BUDGETUpdate a budget attached to a workforce-planning position.

Input Parameters

array
required
At most one position-budget update item.
integer
required
Position ID that owns the budget.
integer
required
Position-budget ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_POSITION_OPENINGUpdate an opening attached to a workforce-planning position.

Input Parameters

array
required
At most one position-opening update item.
integer
required
Position ID that owns the opening.
integer
required
Position-opening ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_PROJECTUpdate an attendance project’s fields and employee audience.

Input Parameters

array
required
Exactly one project update.
integer
required
Project ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_PROJECT_TASKUpdate the name and billable state of a project task.

Input Parameters

array
required
Exactly one task update.
integer
required
Task ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_SKILLSBulk-update API-origin skills resolved by source and externalId locator.

Input Parameters

array
required
Skills to update. Each item uses exact /skill/source and /skill/externalId locator keys and optional documented /skill/* update keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPDATE_TRAINING_CONTENTUpdate one or more training content items for an LMS integration.

Input Parameters

array
required
Training content rows keyed by documented field paths such as /trainingContent/externalIdentifier, /trainingContent/title, /trainingContent/description, /trainingContent/sourceLink, /trainingContent/thumbnail, /trainingContent/duration, /trainingContent/language, /trainingContent/category, /trainingContent/learningGoals, /trainingContent/publishDate, /trainingContent/createdAt, and /trainingContent/intendedFor.
string
required
Provider identifier of the LMS integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPLOAD_CONFIDENTIAL_DOCUMENTUpload a file directly into an employee’s confidential folder.

Input Parameters

string
required
Employee ID that will own the document.
object
required
File to upload to the confidential folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPLOAD_CONFIDENTIAL_DOCUMENT_FROM_URLUpload a document from a URL into an employee’s confidential folder.

Input Parameters

string
required
Employee ID that will own the document.
array
Tags to attach to the document in Bob.
string
URL from which Bob should fetch the document.
string
Document name in Bob.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPLOAD_CUSTOM_FOLDER_DOCUMENTUpload a file directly into an employee’s custom folder.

Input Parameters

string
required
Employee ID that will own the document.
object
required
File to upload to the custom folder.
string
required
Custom folder ID for the upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPLOAD_CUSTOM_FOLDER_DOCUMENT_FROM_URLUpload a document from a URL into an employee’s custom folder.

Input Parameters

string
required
Employee ID that will own the document.
array
Tags to attach to the document in Bob.
string
required
Custom folder ID for the upload.
string
URL from which Bob should fetch the document.
string
Document name in Bob.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPLOAD_SHARED_DOCUMENTUpload a file directly into an employee’s shared folder.

Input Parameters

string
required
Employee ID that will own the document.
object
required
File to upload to the shared folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIBOB_UPLOAD_SHARED_DOCUMENT_FROM_URLUpload a document from a URL into an employee’s shared folder.

Input Parameters

string
required
Employee ID that will own the document.
array
Tags to attach to the document in Bob.
string
URL from which Bob should fetch the document.
string
Document name in Bob.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not