Guides
Signup For Free

Hibob API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for Hibob API as part of the HRIS category

Cancel Time Off Request

  • ID: delete_cancel_time_off_request
  • Operation: write
  • Entities: employee, time off request
  • Summary: The Cancel Time Off Request API allows you to cancel an existing time off request for an employee. It requires the employee ID and the request ID as path parameters. The request is made using the DELETE method. The response indicates a successful cancellation with a 200 status code, but the response body is empty.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Company People Field

  • ID: delete_company_people_field
  • Operation: write
  • Entities: field, company, people
  • Summary: This API endpoint deletes a specific field from the company people fields in the HiBob system. The request requires the 'fieldId' as a path parameter, which is the ID of the field to be deleted. The request must include an 'accept' header with the value 'application/json'. The API returns a 200 status code if the field is deleted successfully, a 400 status code if the field is a Bob default field, and a 404 status code if the field does not exist.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Confidential Document for Employee

  • ID: delete_confidential_document_for_employee
  • Operation: write
  • Entities: document, employee
  • Summary: This API endpoint is used to delete a specific document from a confidential folder of a specific employee in Bob. It requires the path parameters 'id' and 'docId', which represent the employee's ID and the document's ID, respectively. The request must include the 'accept' header set to 'application/json'. Upon successful deletion, a 200 status code is returned with an empty body. If an unexpected error occurs, a default error response is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Custom Table Entry

  • ID: delete_custom_table_entry
  • Operation: write
  • Entities: entry, person, custom table
  • Summary: This API endpoint deletes a specific entry from a custom table for a given employee in the HiBob system. It requires the employee ID, custom table ID, and entry ID as path parameters. The request must include an 'accept' header specifying 'application/json'. Upon successful deletion, a response with a status code 200 is returned, indicating that the entry was deleted successfully. However, no specific response body example is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Document from Employee's Custom Folder

  • ID: delete_document_from_employee_custom_folder
  • Operation: write
  • Entities: document, folder, employee
  • Summary: This API endpoint is used to delete a specific document from a custom folder of a specific employee in Bob. The request requires the employee ID, document ID, and folder ID as path parameters. The 'accept' header must be set to 'application/json'. On successful deletion, the response body is empty. Ensure that the service user has the appropriate permissions to remove the file.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Document from Employee's Shared Folder

  • ID: delete_document_from_employee_shared_folder
  • Operation: write
  • Entities: document, permission, employee
  • Summary: This API endpoint is used to delete a specific document from a shared folder of a specific employee in Bob. The request requires the employee's ID and the document ID as path parameters. The 'accept' header must be set to 'application/json'. On successful deletion, the response body is empty. Ensure that the Service User has the appropriate permissions to remove the file.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Employee Bank Account Entry

  • ID: delete_employee_bank_account_entry
  • Operation: write
  • Entities: entry, employee, bank account
  • Summary: This API endpoint allows you to delete a specific bank account entry for an employee using their employee ID and the bank account entry ID. The DELETE method is used for this operation. The path parameters include 'id', which is the employee's ID, and 'entry_id', which is the ID of the bank account entry to be deleted. The request header can optionally include 'accept' with 'application/json' as the value. The response will be a 200 status code if the entry is deleted successfully, or a 404 status code if the requested entry is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Employee Salary Entry

  • ID: delete_employee_salary_entry
  • Operation: write
  • Entities: entry, salary, person
  • Summary: This API endpoint allows the deletion of a specific salary entry for an employee. It requires the employee ID and the entry ID as path parameters. The request method is DELETE, and it accepts an optional 'accept' header to specify the media type for the response. Upon successful deletion, it returns a 200 status code with a message indicating the entry was deleted successfully. However, no specific response body example is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Employment Entry

  • ID: delete_employment_entry
  • Operation: delete
  • Entities: employment, person
  • Summary: The Delete Employment Entry API allows you to delete a specific employment entry for a given employee. It requires the employee ID and the entry ID as path parameters. The request must include an 'accept' header specifying 'application/json'. Upon successful deletion, a 200 status code is returned indicating the entry was deleted successfully. No response body is provided in the example.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Equity Entry for Employee

  • ID: delete_equity_entry_for_employee
  • Operation: write
  • Entities: person, equity
  • Summary: This API endpoint deletes a specific equity entry for an employee. It requires the employee ID and the entry ID as path parameters. The request is made using the DELETE method. The response indicates whether the entry was successfully deleted, but no specific response body example is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Named List Item

  • ID: delete_named_list_item
  • Operation: write
  • Entities: list item, company, named list
  • Summary: This API endpoint deletes a specific item from a named list in the company database. It requires the 'listName' and 'itemId' as path parameters, which are both mandatory. The request should include an 'accept' header specifying 'application/json'. If the deletion is successful, a 200 status code is returned. If the list or item is not found, a 404 status code is returned. There is no response body example provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Training Entry for Employee

  • ID: delete_training_entry_for_employee
  • Operation: write
  • Entities: entry, people, training
  • Summary: This API endpoint deletes a specific training entry for an employee. It requires the employee's ID and the entry ID to be specified in the path parameters. The request must include an 'accept' header with the value 'application/json'. Upon successful deletion, a 200 status code is returned indicating that the entry was deleted successfully. However, no specific response body example is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Variable Entry for Employee

  • ID: delete_variable_entry_for_employee
  • Operation: write
  • Entities: entry, variable, person
  • Summary: This API endpoint allows the deletion of a specific variable entry for an employee in the HiBob system. The request requires the employee's ID and the entry ID to be specified in the path parameters. The request must include an 'accept' header with the value 'application/json'. Upon successful deletion, a 200 status code is returned with a message indicating the entry was deleted successfully. However, no specific response body example is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Work Entry for Employee

  • ID: delete_work_entry_for_employee
  • Operation: write
  • Entities: entry, work, people
  • Summary: This API endpoint allows the deletion of a specific work entry for an employee. It requires the employee ID and the entry ID as path parameters. The request must include an 'accept' header specifying 'application/json'. Upon successful deletion, a 200 status code is returned with a message indicating the entry was deleted successfully. No response body example is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Open Tasks for Company

  • ID: get_all_open_tasks_for_company
  • Operation: read
  • Entities: company, task
  • Summary: This API endpoint retrieves all open tasks for a company. It uses the GET method and requires the 'accept' header to specify the expected media type in the response, which should be 'application/json'. The response includes a list of tasks, each with an 'id', 'title', 'set', and 'description'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Asynchronously Generate and Download Report

  • ID: get_asynchronously_generate_and_download_report
  • Operation: read
  • Entities: company, report
  • Summary: This API endpoint asynchronously generates a report based on the specified format (csv or xlsx). It requires the reportId as a path parameter and the format as a query parameter. Optional query parameters include includeInfo, locale, and humanReadable. The response includes a Location header with the URL of the newly generated report. The service user must have the required permissions to access this endpoint.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Named Lists

  • ID: get_company_named_lists
  • Operation: read
  • Entities: list, company, item
  • Summary: The Get Company Named Lists API retrieves named lists from the company database. It supports an optional query parameter 'includeArchived' to specify whether archived items should be included in the response. The response is an array of objects, each representing a named list with its name and items. Each item in the list has an ID, name, archived status, and potentially nested children items.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Reports

  • ID: get_company_reports
  • Operation: read
  • Entities: company, report, view
  • Summary: The Get Company Reports API endpoint returns a list of all the company reports with their details. The data is filtered based on the access level of the service user making the call, and only viewable categories are returned. The service user must have the required permissions to access reports. The API does not require any request body or query parameters. The response includes details such as modification date, creator, configuration, comparability, name, description, schedule status, ID, type, creation date, and folder ID of each report.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Custom Table Data for Employee

  • ID: get_custom_table_data_for_employee
  • Operation: read
  • Entities: metadata, employee, custom table
  • Summary: This API endpoint retrieves data from a custom table for a specific employee in the HiBob system. It requires the employee ID and the custom table ID as path parameters. An optional query parameter 'includeHumanReadable' can be used to include a human-readable JSON node in the response. The response contains an array of values, each representing a row in the custom table, with the only guaranteed property being the row ID. The row data structure depends on the table's schema, which can be obtained using the HiBob Custom Table Metadata API.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Custom Table Metadata

  • ID: get_custom_table_metadata
  • Operation: read
  • Entities: column, custom table
  • Summary: This API endpoint retrieves metadata for a specific custom table identified by the 'custom_table_id' path parameter. The request requires an 'accept' header specifying 'application/json'. The response includes details such as the table's ID, category, name, description, and a list of columns with their respective properties like ID, name, description, whether they are mandatory, type, and type-specific data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Custom Tables Metadata

  • ID: get_custom_tables_metadata
  • Operation: read
  • Entities: column, category, table
  • Summary: This API endpoint retrieves metadata for custom tables in the system. It is a GET request to the URL https://api.hibob.com/v1/people/custom-tables/metadata. The request requires an 'accept' header with the value 'application/json'. The response includes a list of custom tables, each with an ID, category, name, description, and a list of columns. Each column has an ID, name, description, a mandatory flag, type, and typeData which may include a listId.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Detailed Info About an Existing Time Off Request

  • ID: get_detailed_info_about_an_existing_time_off_request
  • Operation: read
  • Entities: request, employee, time off policy
  • Summary: This API endpoint retrieves detailed information about an existing time off request for a specific employee. It requires the employee ID and the request ID as path parameters. The response includes various details about the time off request, such as the employee ID, request ID, policy type display name, type of request duration, start and end dates, approval status, total duration, total cost, and any attachments. The response also provides information about who approved or declined the request and the reasons for approval or decline.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Download Company Report

  • ID: get_download_company_report
  • Operation: read
  • Entities: file, company, report
  • Summary: The Download Company Report API allows users to download a report data file in the specified format. The supported formats are csv, xlsx, and json. The API requires a path parameter 'reportId' which is the ID of the report to download. Optional query parameters include 'format' to specify the file format, 'includeInfo' to include additional information, 'locale' to set the language for report columns, and 'humanReadable' to determine the format of JSON responses. The response includes the report file in the specified format, with the report name and execution date included by default.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Avatar Image URL

  • ID: get_employee_avatar_image_url
  • Operation: read
  • Entities: avatar, employee
  • Summary: This API endpoint retrieves the avatar image URL of an employee using their Employee ID or email address. The request is made using the GET method to the URL 'https://api.hibob.com/v1/avatars/{employeeId}'. The 'employeeId' is a required path parameter that can be obtained from the database or the URL in Bob when viewing the employee. The response returns the URL of the employee's avatar image. The 'accept' header can be optionally set to 'application/json'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Bank Account Entries

  • ID: get_employee_bank_account_entries
  • Operation: read
  • Entities:
  • Summary: This API endpoint retrieves a list of bank account entries for a specified employee. The request requires the employee's ID as a path parameter and an 'accept' header specifying 'application/json'. The response includes details about each bank account, such as the type, routing number, account nickname, account number, bank name, branch address, BIC/SWIFT code, IBAN, allocation type, amount, bonus usage, and the ID of the person who last modified the entry.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Compensation Details

  • ID: get_employee_compensation_details
  • Operation: read
  • Entities:
  • Summary: This API endpoint retrieves comprehensive compensation details for a specified employee, including salary history, variable payments, and equity grants. The request requires the employee ID as a path parameter and the 'accept' header to specify the response format as 'application/json'. The response combines data from three different endpoints: salary history, variable payments, and equity grants. Each section of the response includes detailed information such as salary entry ID, reason for change, effective date, base salary value and currency, variable payment amount, type, payment period, and equity grant details like quantity, type, vesting commencement date, and grant status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Documents and Download Links

  • ID: get_employee_documents_and_download_links
  • Operation: read
  • Entities: document, employee
  • Summary: This API endpoint retrieves a list of documents and their download links for a specified employee. The request requires the employee's ID as a path parameter, which can be obtained from the employee data. For testing purposes, the employee's email address can also be used as the ID. The request must include an 'accept' header with the value 'application/json'. The response returns a JSON object containing an array of documents, each with a 'documentName' and a 'downloadLink'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Equity Grants

  • ID: get_employee_equity_grants
  • Operation: read
  • Entities: equity grant, employee
  • Summary: This API endpoint retrieves a list of equity grants for a specified employee. The request requires the employee ID as a path parameter and the 'accept' header set to 'application/json'. The response includes details about each equity grant, such as the quantity, type, vesting commencement date, consent number, grant date, option expiration, exercise price, vesting term, grant type, vesting schedule, grant number, and grant status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Employee Fields Metadata

  • ID: get_employee_fields_metadata
  • Operation: read
  • Entities: field, category, employee
  • Summary: This API endpoint retrieves metadata about employee fields, including all employee fields. It does not require any permissions for the service user performing this action. The endpoint returns an array of objects, each representing a field with properties such as 'id', 'category', 'name', 'description', 'jsonPath', 'type', 'typeData', and 'historical'. The 'type' property indicates the field type, and 'historical' indicates if the field keeps a history of its values.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Lifecycle History

  • ID: get_employee_lifecycle_history
  • Operation: read
  • Entities: life-cycle history, employee
  • Summary: This API endpoint retrieves a list of life-cycle history entries for a specified employee. The request requires the employee ID as a path parameter and the 'accept' header to specify the response format as 'application/json'. The response includes an array of lifecycle entries, each containing details such as the entry ID, reason, effective date, status, and reason type.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Profiles

  • ID: get_employee_profiles
  • Operation: read
  • Entities: work, employee, profile
  • Summary: The Get Employee Profiles API endpoint retrieves a predefined list of fields for all active employees that the service user can access. The API requires the 'accept' header to be set to 'application/json'. The response includes detailed information about each employee, such as their personal details, work information, and social data. The response schema includes fields like 'id', 'firstName', 'surname', 'email', 'displayName', and nested objects for 'personal', 'about', and 'work' details. Ensure the service user has the necessary permissions to access the desired users and fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Salary History

  • ID: get_employee_salary_history
  • Operation: read
  • Entities: salary history, employee
  • Summary: This API endpoint retrieves a list of salary history entries for a specified employee. The request requires the employee ID as a path parameter and the 'accept' header to specify the response format as 'application/json'. The response includes an array of salary entries, each containing details such as the salary entry ID, reason for change, effective date, base salary value and currency, pay period, and pay frequency.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Tasks

  • ID: get_employee_tasks
  • Operation: read
  • Entities: person, task
  • Summary: This API retrieves all tasks for a specific employee. The employee is identified by their ID or email address provided in the path parameter. The API supports filtering tasks by their status (open or closed) using the query parameter 'task_status'. The response includes a list of tasks with details such as task ID, title, set, and description.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Employee Time Off Balance

  • ID: get_employee_time_off_balance
  • Operation: read
  • Entities: policy, employee, balance
  • Summary: This API retrieves the time off balance for a specified employee based on a given policy type and date. The request requires the employee ID (or email), policy type, and date as query parameters. The response includes details such as the employee ID, total balance as of the specified date, rounded balance, starting balance, total taken, adjustments, annual allowance, and policy name.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Training Records

  • ID: get_employee_training_records
  • Operation: read
  • Entities: document, employee, training
  • Summary: This API endpoint retrieves a list of training records for a specified employee. The request requires the employee ID as a path parameter and the 'accept' header to specify the response format as 'application/json'. The response includes an array of training records, each containing details such as the training name, description, cost, status, frequency, start and end dates, and any associated document ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Work History

  • ID: get_employee_work_history
  • Operation: read
  • Entities: department, employee, work history
  • Summary: This API endpoint retrieves a list of work history entries for a specified employee. The request requires the employee ID as a path parameter and the 'accept' header to specify the response format as 'application/json'. The response includes an array of work history entries, each containing details such as the entry ID, reason, effective date, title, department, site, site ID, and reporting manager's details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employment History for Employee

  • ID: get_employment_history_for_employee
  • Operation: read
  • Entities: employee, employment history, contract
  • Summary: This API endpoint retrieves a list of employment history entries for a specified employee. The request requires the employee ID as a path parameter and the 'accept' header set to 'application/json'. The response includes an array of employment history entries, each containing details such as the entry ID, reason, effective date, contract type, employment type, and salary pay type.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Folder Metadata

  • ID: get_folder_metadata
  • Operation: read
  • Entities: folder, metadata
  • Summary: This API endpoint retrieves a list of available folders and their metadata, including the folder ID, name, and type. The folder ID can be used when uploading a file to a specific folder. The request requires an 'accept' header with the value 'application/json'. The response returns an array of folder objects, each containing an ID, name, and folder type. Predefined folder types can be 'confidential' or 'shared', while user-defined folders are marked as 'custom'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Historical Employment Entries

  • ID: get_historical_employment_entries
  • Operation: read
  • Entities: employment, permission, employee
  • Summary: This API endpoint retrieves a list of historical employment entries from the employment table for all employees or a specific list of employees. The service user must have specific permissions to access the employment history. The endpoint supports cursor-based pagination and accepts query parameters such as 'limit', 'cursor', and 'employeeIds'. The response includes employment details such as contract, type, salary pay type, and effective date, along with pagination metadata and error information for employees that cannot be accessed due to permission issues.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Historical Lifecycle Entries for Employees

  • ID: get_historical_lifecycle_entries_for_employees
  • Operation: read
  • Entities: permission, employee, lifecycle entry
  • Summary: This API endpoint retrieves a list of historical lifecycle entries from the lifecycle table for all employees or a specified list of employees. The service user must have the necessary permissions to access the lifecycle history of each requested employee. The endpoint supports cursor-based pagination to handle large datasets. The request can include query parameters such as 'limit' to specify the number of entries per page, 'cursor' for pagination, and 'employeeIds' to filter the results by specific employees. The response includes the lifecycle entries, pagination metadata, and any errors related to permission issues.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Historical Salary Entries

  • ID: get_historical_salary_entries
  • Operation: read
  • Entities: salary, employee, payroll
  • Summary: This API endpoint retrieves a list of historical salary entries from the payroll table for all employees or a specified list of employees. It requires specific permissions to access payroll history. The endpoint supports cursor-based pagination and accepts query parameters such as 'limit' to specify the number of entries per page, 'cursor' for pagination, and 'employeeIds' to filter by specific employees. The response includes salary details such as employee ID, salary values, pay period, and frequency, along with metadata for pagination and any errors related to permission issues.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Historical Work Entries for Employees

  • ID: get_historical_work_entries_for_employees
  • Operation: read
  • Entities: department, employee, work entry
  • Summary: This API endpoint retrieves a list of historical work entries from the work table for all employees or a specific list of employees. It requires specific permissions to access the work history of each requested employee. The endpoint supports cursor-based pagination to handle large datasets. The request can include query parameters such as 'limit' to specify the number of entries per page, 'cursor' for pagination, and 'employeeIds' to filter by specific employees. The response includes the work entries with details such as employee ID, job title, department, site, and manager information. Errors are returned for employees that the service user does not have permission to access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Ad Details

  • ID: get_job_ad_details
  • Operation: read
  • Entities: job ad, department, site
  • Summary: This API endpoint retrieves the details of a specific job ad that was promoted on the Bob careers page. The request requires the job ad ID as a path parameter and optionally accepts a preferred language as a query parameter. The response includes detailed information about the job ad, such as its title, department, employment type, site, country, language code, description, requirements, responsibilities, and benefits. The response is returned in JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get List of People Out Today

  • ID: get_list_of_people_out_today
  • Operation: read
  • Entities: policy, employee, time off request
  • Summary: This API endpoint returns a list of people who have a time off request for today or a specified date. It supports service user types and requires specific permissions to access. The request does not require a body but accepts query parameters such as 'today' for the date, 'includeHourly' to include hourly requests, 'includePrivate' to show policy type names, and 'siteId' for the employee's site ID. The response includes details about each employee's time off, such as employee ID, display name, email, policy type, start and end dates, and the duration of the time off.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Onboarding Wizards Information

  • ID: get_onboarding_wizards_information
  • Operation: read
  • Entities: wizard, user
  • Summary: This API endpoint retrieves information about onboarding wizards. It returns a list of wizards, each with a unique ID and name. The request requires an 'accept' header specifying 'application/json'. The response includes a JSON object with an array of wizards, where each wizard has an 'id' and 'name'. This API is intended for use by service-type users.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Payroll History

  • ID: get_payroll_history
  • Operation: read
  • Entities: department, employee, payroll
  • Summary: The Get Payroll History API retrieves payroll data for employees. It supports filtering by department and can include inactive employees if specified. The request requires an 'accept' header with 'application/json'. Query parameters include 'department' for filtering by department and 'showInactive' to include inactive employees. The response includes detailed employee information such as full name, work details, and personal information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Policy Names for Defined Policy Type

  • ID: get_policy_names_for_defined_policy_type
  • Operation: read
  • Entities: policy, policy name, policy type
  • Summary: This API endpoint retrieves a list of policy names for a user's defined policy type. It requires a query parameter 'policyTypeName' which specifies the type of policy for which names are to be retrieved. The request must include an 'accept' header indicating that the response should be in JSON format. The response returns a list of policy names in JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Policy Type Details

  • ID: get_policy_type_details
  • Operation: read
  • Entities: unit, policy type, activity
  • Summary: This API endpoint retrieves details about a specific policy type in the time-off system. The request requires the 'policyType' path parameter, which specifies the name of the policy type to retrieve. The response includes details such as the name of the policy, the activity type (e.g., paidTimeoff, unpaidTimeoff, workTime), whether requests are deducted only for working days, and the unit of time (days or hours). The response is returned in JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Policy Type Names

  • ID: get_policy_type_names
  • Operation: read
  • Entities: time off, policy type
  • Summary: This API endpoint retrieves a list of all policy type names available in the system. It uses the GET method and requires the 'accept' header to specify the expected media type in the response, which should be 'application/json'. The response includes a JSON object with a 'policyTypes' array containing the names of the policy types. In case of an unexpected error, a default error response is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Position Metadata Fields

  • ID: get_position_metadata_fields
  • Operation: read
  • Entities: field, type, position
  • Summary: This API endpoint retrieves a list of all fields of the object type 'position'. It requires a GET request to the specified URL with the 'accept' header set to 'application/json'. The response includes details about each field, such as its ID, name, description, field type, and JSON path. The field type includes the type of the field and any associated type data, such as a list ID. The JSON path provides the location of the field value and other properties.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Reason Codes for Policy Type

  • ID: get_reason_codes_for_policy_type
  • Operation: read
  • Entities: reason code, policy type
  • Summary: This API endpoint retrieves a list of reason codes for a specified policy type. The request requires the 'policyType' as a path parameter, which is the name of the policy type for which reason codes are being requested. The response includes a list of reason codes, each with an 'id' and 'displayName'. If the specified policy type is not found, a 404 error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Time Off Information for a Date Range

  • ID: get_time_off_information_for_a_date_range
  • Operation: read
  • Entities: employee, policy type, time off request
  • Summary: This API endpoint retrieves time off information for a specified date range. It supports different user types and requires specific permissions based on the parameters used. The request is made using the GET method to the URL 'https://api.hibob.com/v1/timeoff/whosout'. The query parameters include 'from' and 'to' which are required and specify the start and end dates of the period. Optional parameters include 'includeHourly', 'includePrivate', and 'includePending' which control the inclusion of hourly requests, private policy names, and pending requests, respectively. The response contains an array of time off requests with details such as request ID, employee ID, policy type, request type, start and end dates, and status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Time Off Policy Details

  • ID: get_time_off_policy_details
  • Operation: read
  • Entities: policy, allowance, balance
  • Summary: This API endpoint retrieves details about a specific time off policy by its name. The request requires a query parameter 'policyName' which specifies the name of the policy to retrieve. The response includes details such as the policy's name, base annual allowance, maximum and minimum balance, years of service increases, minimum time off request duration, whether approval is required, a description of the policy, and the unit of time (days or hours). If the policy is not found, a 404 error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Time Off Request Changes

  • ID: get_time_off_request_changes
  • Operation: read
  • Entities: change, employee, time off request
  • Summary: This API endpoint retrieves a list of time off requests that have been changed (created, canceled, or deleted) since a specified date. The request requires a 'since' query parameter in ISO-8601 format to specify the starting point for changes. An optional 'includePending' query parameter can be used to include pending requests in the results. The response includes details about each change, such as the type of change, employee information, request details, and the duration and cost of the time off.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Variable Payments for Employee

  • ID: get_variable_payments_for_employee
  • Operation: read
  • Entities: variable payment, department, employee
  • Summary: This API endpoint retrieves a list of variable payments for a specified employee. The request requires the employee ID as a path parameter and the 'accept' header to specify the response format as 'application/json'. The response includes an array of variable payment objects, each containing details such as the payment amount, currency, type, payment period, and various percentage weights related to company, department, and individual performance.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Bank Account for Employee

  • ID: post_add_bank_account_for_employee
  • Operation: write
  • Entities: employee, person, bank account
  • Summary: This API endpoint allows you to add a bank account entry for a specific employee identified by their ID. The request requires the employee ID as a path parameter and the bank account details in the request body. The request headers must include 'accept' and 'content-type' set to 'application/json'. Upon successful creation, a 200 status code is returned, but no specific response body is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employment Entry for Employee

  • ID: post_add_employment_entry_for_employee
  • Operation: write
  • Entities: employment, list
  • Summary: This API endpoint is used to add an employment entry for a specific employee identified by their ID. The request is made using the POST method to the URL https://api.hibob.com/v1/people/{id}/employment. The path parameter 'id' is required and represents the employee ID. The request body must contain the employment entry details in JSON format, and it must not conflict with another entry on the same effective date. The headers must include 'accept' and 'content-type' set to 'application/json'. Upon successful creation of the entry, a 200 status code is returned. Note that the response example is not provided in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Equity Grant for Employee

  • ID: post_add_equity_grant_for_employee
  • Operation: write
  • Entities: list, people, equity
  • Summary: This API endpoint is used to add an equity grant for a specific employee identified by their ID. The request is made using the POST method to the URL https://api.hibob.com/v1/people/{id}/equities, where {id} is the path parameter representing the employee's ID. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body should contain the details of the equity grant to be added. Upon successful addition, the API returns a 200 status code with a message indicating that the entry was added successfully. Note that the values of list fields represent list item IDs, and the HiBob metadata API can be used to determine the corresponding list item values.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Reason Codes for Policy Type

  • ID: post_add_reason_codes_for_policy_type
  • Operation: write
  • Entities: reason code, policy type
  • Summary: This API endpoint allows adding a list of reason codes for a specified policy type. It requires the 'policyType' as a path parameter, which is the name of the policy type. The request body must include 'reasonCodes', an array of strings representing the reason codes to be added. The request headers must specify 'accept' and 'content-type' as 'application/json'. The API returns a 200 status code if the submission is successful, or a 404 status code if the specified policy type is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Salary Entry for Employee

  • ID: post_add_salary_entry_for_employee
  • Operation: write
  • Entities: salary, employee
  • Summary: This API endpoint allows you to add a salary entry for a specific employee identified by their ID. The request requires the employee ID as a path parameter and a salary entry in the request body. The request headers must include 'accept' and 'content-type' set to 'application/json'. The salary entry must not conflict with another entry on the same effective date. A successful response indicates that the entry was added successfully.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Training Entry for Employee

  • ID: post_add_training_entry_for_employee
  • Operation: write
  • Entities: employee, people, training
  • Summary: This API endpoint allows you to add a training entry for a specific employee identified by their ID. The request requires the employee ID as a path parameter and a JSON object in the body representing the training entry to be added. The request headers must include 'accept' and 'content-type' set to 'application/json'. Upon successful addition of the training entry, a 200 status code is returned. Note that the response example is not provided in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Variable Payment for Employee

  • ID: post_add_variable_payment_for_employee
  • Operation: write
  • Entities: list item, variable payment, employee
  • Summary: This API endpoint is used to add a variable payment for an employee in the HiBob system. The request requires the employee ID as a path parameter and a JSON object in the request body representing the variable payment to be added. The request headers must include 'accept' and 'content-type' set to 'application/json'. Upon successful addition, the API returns a 200 status code with a message indicating the entry was added successfully. Note that the values of list fields represent list item IDs, not values. Use the HiBob metadata API to map these IDs to values.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Work Entry for Employee

  • ID: post_add_work_entry_for_employee
  • Operation: write
  • Entities: work, employee
  • Summary: This API endpoint is used to add a work entry for an employee identified by their ID. The request is made using the POST method to the URL https://api.hibob.com/v1/people/{id}/work. The path parameter 'id' is required and represents the Employee ID. The request headers must include 'accept' and 'content-type' both set to 'application/json'. The request body must contain the work entry details, ensuring it does not conflict with another entry on the same effective date. Upon successful creation, a 200 response is returned indicating the entry was created successfully. Note that the response example is not provided in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Complete Task

  • ID: post_complete_task
  • Operation: write
  • Entities: task
  • Summary: This API endpoint is used to mark a task as complete. It requires the task ID as a path parameter. The request should include an 'accept' header specifying 'application/json'. The response will include a list of tasks with their details such as id, title, set, and description.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Company People Field

  • ID: post_create_company_people_field
  • Operation: write
  • Entities: field, category, type
  • Summary: This API endpoint allows the creation of a new field for company people in the HiBob system. The request must include headers specifying 'accept' and 'content-type' as 'application/json'. The request body requires 'name', 'category', and 'type' fields, with optional 'description' and 'historical' fields. The response returns the ID of the newly created field if successful. Errors may occur if the category is 'root', 'historical' is set to true but not allowed, or if the field type is unsupported.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Employee Balance Adjustment

  • ID: post_create_employee_balance_adjustment
  • Operation: write
  • Entities: policy, adjustment, employee
  • Summary: This API endpoint allows you to create a balance adjustment for a specific employee identified by their ID or email address. The adjustment can be of type 'balance' or 'daysUsed' and is applied to a specified policy type. The request requires an effective date for when the adjustment should take effect, the amount of days or hours to adjust, and a reason for the adjustment. The response will indicate success or an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Entry in Custom Table for Employee

  • ID: post_create_entry_in_custom_table_for_employee
  • Operation: write
  • Entities: employee, custom table
  • Summary: This API endpoint allows you to create an entry in a custom table for a specific employee. It requires the employee ID and the custom table ID as path parameters. The request body must be in JSON format and include the data to be inserted into the custom table. The headers must specify 'accept' and 'content-type' as 'application/json'. Upon successful creation, the API returns a 200 status code, but no specific response body is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create New Employee Record in Bob

  • ID: post_create_new_employee_record
  • Operation: write
  • Entities:
  • Summary: This API endpoint creates a new employee record in Bob. It requires the employee's first name, surname, and email address as mandatory fields. Additionally, the work details such as site and start date are also required. The API responds with the newly created employee's details, including full name, display name, creation date, work information, and personal details like avatar URL and about section.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Item in a Named List

  • ID: post_create_new_item_in_named_list
  • Operation: write
  • Entities: list item, company, named list
  • Summary: This API endpoint allows you to create a new item in a named list within the company. The request requires the path parameter 'listName', which is the internal name of the list. The request body must include the 'name' of the item to be created and optionally a 'parentId' if the list is hierarchical. The response will return the ID of the newly created item, which can be either textual or numeric. If the list is not found, a 404 error is returned. If the item already exists, a 409 error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Import Attendance Data

  • ID: post_import_attendance_data
  • Operation: write
  • Entities: event, attendance, employee
  • Summary: The Import Attendance Data API allows you to import attendance records for employees. The API accepts a POST request to the endpoint https://api.hibob.com/v1/attendance/import/{importMethod}, where the importMethod path parameter specifies whether the data should be processed via an aggregation engine ('aggregate') or immediately ('immediate'). The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body requires 'idType' to specify the ID type for identifying employees and 'requests' which is a list of attendance events. Each event can include 'id', 'clockIn', and 'clockOut' timestamps. An optional 'dateTimeFormat' can be provided to set a custom date format. The response includes the import status, total events received, number of events imported, number of events not imported, and any errors encountered.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Employee Data

  • ID: post_retrieve_employee_data
  • Operation: read
  • Entities:
  • Summary: This API endpoint retrieves data fields of a specified employee using their identifier, which can be an employee ID or email address. The request is made using a POST method and requires headers for 'accept' and 'content-type' both set to 'application/json'. The path parameter 'identifier' is mandatory. The request body can optionally include 'fields' to specify which fields to return and 'humanReadable' to determine the format of the data. The response includes detailed employee information such as full name, work details, and personal information. The API only returns non-historical fields and is limited to employee data, excluding positions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Search Active Job Ads on Bob Career Page

  • ID: post_search_active_job_ads
  • Operation: read
  • Entities: job ad, employment type, department
  • Summary: This API endpoint allows users to search for active job ads as promoted on the Bob career page. It uses a POST method to send requests to the endpoint 'https://api.hibob.com/v1/hiring/job-ads/search'. The request can include headers specifying 'accept' and 'content-type' as 'application/json'. The query parameter 'preferredLanguage' can be used to specify the language of the job ads. The request body must include 'fields' and 'filters' parameters. 'Fields' is an array of field IDs to fetch, and 'filters' is an array to narrow down search results. The response returns an array of job ads with details such as job ID, title, apply URL, department, employment type, site, country, language code, description, requirements, responsibilities, and benefits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Search Company Positions

  • ID: post_search_company_positions
  • Operation: read
  • Entities: field, position, filter
  • Summary: This API endpoint allows users to search for company positions by specifying fields to retrieve and filters to apply. The request is made via a POST method and requires a JSON body with 'fields' and 'filters' as mandatory parameters. The 'fields' parameter is an array of field IDs to fetch, while 'filters' is an array of conditions to apply. The response includes details about each position, such as its status, employment type, and department. The service user must have specific permissions to access this endpoint.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Search Employees Data

  • ID: post_search_employees_data
  • Operation: read
  • Entities:
  • Summary: This API endpoint allows you to search and retrieve data fields of employees using a POST request. The request body can include optional parameters such as 'fields' to specify which fields to return, 'filters' to filter the results based on specific conditions, 'showInactive' to include inactive employees, and 'humanReadable' to determine the format of the data returned. The response includes detailed information about employees, such as their full name, display name, creation date, work details, avatar URL, and more. The API only returns non-historical fields and is limited to employee data, not positions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Send Employee Invitation

  • ID: post_send_employee_invitation
  • Operation: write
  • Entities: employee, invitation, welcome wizard
  • Summary: This API endpoint is used to send an invitation to an employee using their Employee ID or email address. The request requires the 'employeeId' as a path parameter and a 'welcomeWizardId' in the request body. The headers must include 'accept' and 'content-type' set to 'application/json'. A successful response indicates that the invitation was submitted successfully, while an unexpected error will return a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Set Employee Start Date

  • ID: post_set_employee_start_date
  • Operation: write
  • Entities: reason, start date, employee
  • Summary: This API sets the start date for an employee in the HiBob system. It requires the employee ID or email address as a path parameter. The request body must include the 'startDate' field, which specifies the date the entry becomes effective, and optionally a 'reason' field for additional information. The API responds with a 200 status code if the start date is set successfully, or an error message for unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Submit a New Time Off Request

  • ID: post_submit_new_time_off_request
  • Operation: write
  • Entities: employee, policy type, time off request
  • Summary: This API endpoint allows the submission of a new time off request for an employee. The request can be of various types such as days, hours, different hours per day, same portion per day, or same hours per day. The path parameter 'id' is required and represents the Employee ID. The request body must include details such as requestRangeType, policyType, startDate, and endDate, among others, depending on the type of request. The response indicates successful submission but does not provide a detailed response example.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Terminate Employee

  • ID: post_terminate_employee
  • Operation: write
  • Entities: employee, termination
  • Summary: This API endpoint is used to change an employee's status to Terminated according to a specified termination date. The request requires the employee's identifier, which can be either the Employee ID or email address. The request body must include the termination date and can optionally include the termination reason, reason type, notice period, and last day of work. The response indicates whether the termination entry was added successfully.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Uninvite Employee

  • ID: post_uninvite_employee
  • Operation: write
  • Entities: employee
  • Summary: The Uninvite Employee API is used to revoke access for an employee in the system. It requires a POST request to the specified endpoint with the employee's identifier, which can be either the Employee ID or the employee's email address. The request must include an 'accept' header specifying 'application/json'. The response will indicate whether the revocation was successful or if there was an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Upload File to Employee's Confidential Folder

  • ID: post_upload_file_to_employee_confidential_folder
  • Operation: write
  • Entities: file, employee
  • Summary: This API endpoint allows you to upload a file directly into a confidential folder of a specific employee in Bob. To use this endpoint, you must have the appropriate permissions set for the Service User. The request requires the employee's ID as a path parameter and the file to be uploaded as a binary in the request body. The response will return the uploaded document ID if successful, or an error identifier in case of an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Upload File to Employee's Custom Folder

  • ID: post_upload_file_to_employee_custom_folder
  • Operation: write
  • Entities: folder, file, employee
  • Summary: This API endpoint allows you to upload a file directly into a custom folder of a specific employee in Bob. You need to ensure that the Service User has the correct permissions to upload the file. The request requires the employee's ID and the custom folder ID as path parameters. The file to be uploaded should be included in the request body as multipart/form-data. The response will return the uploaded document ID if successful, or an error identifier in case of an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Upload File to Employee's Shared Folder

  • ID: post_upload_file_to_employee_shared_folder
  • Operation: write
  • Entities: permission, file, employee
  • Summary: This API endpoint allows you to upload a file directly into a shared folder of a specific employee in Bob. To use this endpoint, you must have the appropriate permissions set for the Service User. The request requires the employee's ID as a path parameter and the file to be uploaded as a binary in the request body. The response will return the uploaded document ID if successful, or an error message if there is an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Change Employee Email Address

  • ID: put_change_employee_email_address
  • Operation: write
  • Entities: employee, email
  • Summary: This API endpoint allows changing an employee's email address. If the email cannot be changed directly, an invitation will be sent to the new email address for verification if the employee is invited or active. The request requires the employee ID as a path parameter and the new email address in the request body. The response indicates whether the invitation was sent successfully.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Company People Field

  • ID: put_update_company_people_field
  • Operation: write
  • Entities: field, description, name
  • Summary: This API endpoint updates the name and/or description of a specific field in the company people fields. It requires the field ID as a path parameter. The request body should contain the new name and/or description of the field. The request headers must include 'accept' and 'content-type' set to 'application/json'. A successful update returns a 200 status code, while a 404 status code is returned if the field does not exist.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Custom Table Entry

  • ID: put_update_custom_table_entry
  • Operation: write
  • Entities: entry, employee, custom table
  • Summary: This API endpoint updates an entry in a custom table for a specific employee. It requires the employee ID, custom table ID, and entry ID as path parameters. The request body should contain the data to update in the custom table entry, formatted as a JSON object. The request headers should specify 'accept' and 'content-type' as 'application/json'. Upon successful update, the API returns a 200 status code, but no specific response body is provided in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Bank Account Entry

  • ID: put_update_employee_bank_account_entry
  • Operation: write
  • Entities:
  • Summary: This API endpoint updates an entry in the employee’s bank accounts table. The unique identifier for the bank account entry is the entry_id. To obtain the bank account entry, use the GET /people/{id}/bank-accounts endpoint. Note that the entire bank account entry will be replaced with the data provided in your payload, so make sure to provide all the fields and not only the fields you want to update. The request requires the employee ID and the bank account entry ID as path parameters, and the entire bank account entry data as the request body. The response will indicate whether the update was successful or if the requested entry was not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Record in Bob

  • ID: put_update_employee_record_in_bob
  • Operation: write
  • Entities: field, employee
  • Summary: This API endpoint updates the employee record in Bob. It allows updating only the fields listed in the Fields Metadata API where historical is equal to false. Only People fields are supported, and position fields cannot be updated using this endpoint. The request requires the employee identifier, which can be the Employee ID or email address, and a JSON body with the fields to update. The response indicates whether the update was successful or if no changes were made.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Work History Entry

  • ID: put_update_employee_work_history_entry
  • Operation: write
  • Entities: work history entry, employee
  • Summary: This API endpoint updates an entry in the employee’s work history table. The unique identifier for the work entry is the site and effective date. The entire work entry will be replaced with the data provided in the payload. A patchUpdate flag can be used for legacy purposes to update only the fields included in the payload, leaving others unchanged. The path parameters include 'id' for the employee ID and 'entry_id' for the work entry ID. The request body must contain the entire work entry data. The response will indicate success with a 200 status or a 404 status if the entry is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employment Entry for a Person

  • ID: put_update_employment_entry_for_a_person
  • Operation: write
  • Entities: employment, entry, employee
  • Summary: This API endpoint updates an employment entry for a specific person identified by the employee ID and entry ID. The request requires path parameters 'id' for the employee ID and 'entry_id' for the entry ID to update. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body is required but not specified in detail. The response indicates whether the entry was updated successfully, but no specific response example is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Equity Entry for Employee

  • ID: put_update_equity_entry_for_employee
  • Operation: write
  • Entities: person, entry, equity
  • Summary: This API endpoint updates an equity entry for a specific employee identified by the 'id' path parameter. The 'entry_id' path parameter specifies the entry to be updated. The request must include headers specifying 'accept' and 'content-type' as 'application/json'. The request body must be a JSON object with specific properties. The response indicates whether the entry was updated successfully, but no specific response body example is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Named List Item

  • ID: put_update_named_list_item
  • Operation: write
  • Entities: list item, company, named list
  • Summary: This API endpoint updates a named list item in the company's list. It requires the path parameters 'listName' and 'itemId' to identify the list and item to be updated. The request body must include at least one of the fields 'name' or 'parentId'. Providing a 'name' will rename the list item, while providing a 'parentId' will move the item under a new parent node in the hierarchy. The API returns a 200 status code if the update is successful, or a 404 status code if the list or item is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Upload Employee Avatar

  • ID: put_upload_employee_avatar
  • Operation: write
  • Entities: avatar, employee
  • Summary: This API endpoint allows you to upload an employee's avatar by providing a URL to the image. The request requires the employee's ID as a path parameter and the URL of the avatar image in the request body. The request headers should include 'accept' and 'content-type' set to 'application/json'. Upon successful upload, a 200 status code is returned indicating the avatar was uploaded successfully.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Compensation Details

  • ID: update_compensation_information_for_an_employee
  • Operation: write
  • Entities:
  • Summary: This API endpoint allows you to update employee details by adding equity grants, salary entries, and variable payments for a specific employee identified by their ID. The request requires the employee ID as a path parameter and the details to be updated in the request body. The request headers must include 'accept' and 'content-type' set to 'application/json'. The salary entry must not conflict with another entry on the same effective date. A successful response indicates that the entries were added successfully.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago