v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Attendance

Import attendance data

This endpoint allows you to import attendance punches (entries) for employees.

Before using this endpoint:

post/attendance/import/{importMethod}

Path parameters

importMethod'aggregate' | 'immediate' required

Indicates if the provided data should be processed via an aggregation engine or immediately. <ul>Aggregate - will add the logs to a temporary location, and an aggregation job will process the data asynchronously.</ul><ul>Immediate - will insert the records as-is.</ul>

Request body

idTypestring required

The ID type used to identify the employee. Can be one of: "bobId", "email", "idInCompany", or a custom field.<br/>For <b>custom fields</b> a forward slash separator should be used.<br/>In order to use a specific custom field to identify an employee, for example a custom field called "Payroll integration ID":<ul><li>Query the field name via the <a href='https://apidocs.hibob.com/reference/get_company-people-fields'>"Get all company fields"</a></li><li>In the response the name will look like <b>"identification.custom.Payroll Integration ID_1RNhIIf"</b></li><li>The value to use should be: <b>"/identification/custom/Payroll Integration ID_1RNhI"</b></li></ul>

dateTimeFormatstring

Allows to set custom date format for the date-time values sent in the requests

Example request

{
  "requests": [
    {
      "id": "12356733644",
      "clockIn": "2022-06-12T08:00",
      "clockOut": "2022-06-12T17:00",
      "entryType": "work"
    }
  ],
  "dateTimeFormat": "yyyy-MM-dd hh:mm a"
}

Response

Records imported

status'success' | 'failed' | 'partial_success'

Import status

totalnumber

Total number of clock-in and clock-out events received

importednumber

Number of clock-in/clock-out events imported

notImportednumber

Number of clock-in/clock-out events which were not imported

errorsstring[]

List of all errors received in the process

Example response

{
  "total": 140,
  "imported": 137,
  "notImported": 3,
  "errors": [
    "Clock-In at 2022-04-07T07:00 for employee ID 2686495591877312534 is invalid",
    "Invalid employee Id: ABCD12345567",
    "Cannot find employee for id 5986745"
  ]
}