Sign in

v1

OpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB
Employees|Employee

Fetch employee list.

This endpoint enables you to retrieve a list of employees. Employees may be issued with an RFID or iButton key. The key value is provided in the iButton and iButtonNumber fields. Additionally, employees may belong to a department that determines their time model. Furthermore, essential information such as their name and entry and exit date is included in the base data.

get/employee/fetch

Query parameters

employees[byIds][]integer[]

Filters the employee based on the IDs.

employees[byReferences][]string[]

Filters the employees based on the personal numbers.

employees[byCardNumbers][]string[]

Filters the employees based on the driver card numbers.

employees[byIbuttonNumbers][]integer[]

Filters the employees based on the iButton numbers.

employees[byImportKeys][]string[]

Filters the employees based on the employee import IDs.

employees[importSource]string

Name of the external data source. (Default is "*API")

This parameter is only required if the external employee ID is filtered.

offsetinteger

Use this parameter to specify the number of records you want to skip before starting to collect the data from the result set. This paramter is optional.

limitinteger

The limit parameter defines the maximum number of records that can be retrieved in a single API request, with a max and default value set at 500 records. This paramter is optional.

Response

Success Response:

offsetinteger

Number of skipped records.

totalCountinteger

Total number of available employees. (Only calculated if the offset is 0)

Example response

{
  "data": [
    {
      "entryDate": "2015-02-20",
      "dayOfBirth": "2015-02-20",
      "terminationDate": "2015-02-20",
      "healthInsuranceFromDate": "2015-02-20",
      "cardExpiresOn": "2015-02-20T12:59:21+01:00",
      "location": {
        "createdAt": "2015-02-20T12:59:21+01:00"
      },
      "assignedDispoQualifications": [
        {
          "createdAt": "2015-02-20T12:59:21+01:00"
        }
      ]
    }
  ]
}