---
title: "Fetch employee list."
method: GET
path: "/employee/fetch"
tags: ["Employees|Employee"]
---

# Fetch employee list.

`GET /employee/fetch`

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.

## Query parameters

- `employees[byIds][]` integer[]
- `employees[byReferences][]` string[]
- `employees[byCardNumbers][]` string[]
- `employees[byIbuttonNumbers][]` integer[]
- `employees[byImportKeys][]` string[]
- `employees[importSource]` string
- `offset` integer
- `limit` integer

## Response `200`

Success Response:

- StandardEmployeeFetchResponse
  - `data` object[] — The employees.
    - `id` integer — The internal employee ID.
    - `reference` string — The personal number. (max. 20 characters)
    - `cardNumber` string — The driver card number.
    - `importSource` string — External data source from which this employee originates. (max. 16 characters)
    - `importKey` string — External ID from the respective data source. (max. 64 characters)
    - `firstName` string — The first name of the employee. (max. 128 characters)
    - `lastName` string — The last name of the Employee. (max. 128 characters)
    - `name` string — This field is deprecated. Please use firstName The complete Name of the Employee If first name or last name is set, name is ignored.
    - `phoneNumber` string — The phone number (max. 128 characters)
    - `ibutton` string — The iButton as hexadecimal value.
    - `ibuttonNumber` integer — The iButton as number. (max. 32 characters)
    - `email` string — The e-mail address. (max. 128 characters)
    - `costCenter` string — The cost center. (max. 32 characters)
    - `entryDate` string — Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd
    - `dayOfBirth` string — Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd
    - `gender` string — The employee's gender. (MALE, FEMALE, NONBINARY)
    - `numVacationDays` number — The number of vacation days the employee has per year.
    - `terminationDate` string — Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd
    - `socialSecurityNumber` string — The social security number for the employee. (max. 25 characters)
    - `healthInsuranceFromDate` string — Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd
    - `healthInsuranceType` string — The health insurance type (STATUTORY/PRIVATE).
    - `healthInsuranceName` string — The name of the employees health insurance
    - `cardExpiresOn` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `department` DepartmentFetchResponseDepartmentItem
      - `id` integer — The internal id of the department.
      - `name` string — The name of the department.
      - `parent` string — The name of the departments parent.
    - `location` StandardLocationBaseLocationListItem
      - `id` integer — The internal id of the location category.
      - `name` string — The name of the location.
      - `externalId` string — The external ID of the location.
      - `createdAt` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `assignedDispoQualifications` object[] — All dispo qualifications assigned to the employee.
      - `id` integer — The internal id of the dispo qualification.
      - `name` string — The name of the dispo qualification.
      - `createdAt` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
  - `offset` integer — Number of skipped records.
  - `totalCount` integer — Total number of available employees. (Only calculated if the offset is 0)

---

[API](https://skmtc.net/geocapture/apis/geocapture-api.md) · [All operations](https://skmtc.net/geocapture/apis/geocapture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/geocapture/geocapture-api/versions/869b05603541/schema)