Mitarbeiter auflisten

Liefert eine paginierte Liste der Mitarbeiter, einschließlich ihrer Kategorien und dynamischen Attribute, filterbar nach den Feldern des Mitarbeiterdatensatzes.

Verfügbarkeit: Vollversion und ZEP Clock

Request

GET /api/v1/employees

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/employees' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Query-Parameter

Name
perPage
Type
integer, nullable
Description
Wird auf diesem Endpunkt ignoriert — senden Sie stattdessen limit. Ein hier angegebener Wert wird durch limit ersetzt, oder durch den Standardwert, wenn limit fehlt.
Name
page
Type
integer, nullable
Description
Die zurückzugebende Ergebnisseite, beginnend bei 1.
Name
orderBy
Type
string, nullable
Description
Name des Feldes, nach dem sortiert wird.
Name
order
Type
string, nullable
Description
Sortierrichtung, aufsteigend oder absteigend.
Einer der Werte: "asc", "desc"
Name
limit
Type
integer, nullable
Description
Die Anzahl der Datensätze pro Seite, 1 bis 200. Standardwert ist 15.
Name
modified_after
Type
string (date-time)
Description
Nur Datensätze zurückgeben, die nach diesem Zeitstempel geändert wurden (ISO 8601 oder “Y-m-d H:i:s”).
Name
modified_before
Type
string (date-time)
Description
Nur Datensätze zurückgeben, die vor oder zu diesem Zeitstempel geändert wurden (ISO 8601 oder “Y-m-d H:i:s”).
Name
personal_number[]
Type
Liste von string, nullable
Description

Response

{
  "data": [
    {
      "username": "max.mustermann",
      "firstname": "Max",
      "lastname": "Mustermann",
      "personal_number": "1",
      "street": "Musterstraße 30",
      "zip": "71254",
      "city": "Berlin",
      "country": "Deutschland",
      "abbreviation": "MM",
      "salutation": {
        "id": "string",
        "name": "Herr"
      },
      "title": "Dr.",
      "email": "erika.mustermann@acme-corp.de",
      "phone": "+49 30 12345678",
      "mobile": "+49 170 1234567",
      "fax": "+1-555-0124",
      "private_phone": "07156 33958",
      "birthdate": "1985-08-17T00:00:00.000000Z",
      "iban": "DE89370400440532013000",
      "bic": "COBADEFFXXX",
      "account_no": "string",
      "bank_name": "string",
      "bank_code": "string",
      "currency": "EUR",
      "approval_date": "2026-01-31T09:00:00.000000Z",
      "vat": 1.5,
      "price_group": "Junior-Entwickler",
      "employment": {
        "id": "string",
        "name": "Mitarbeiter/in"
      },
      "rights": {
        "id": "string",
        "name": "User"
      },
      "department_id": 1,
      "language": {
        "locale": "string",
        "isoCode": "de",
        "name": "deutsch",
        "dateFormat": "d.m.Y",
        "dateTimeFormat": "d.m.Y H:i",
        "numberFormat": {
          "decimalSeparator": "string",
          "thousandsSeparator": "string"
        }
      },
      "personio_id": "string",
      "cost_bearer": "string",
      "tax_id": "string",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z",
      "creditor_number": "80033",
      "categories": [
        {
          "name": "EU",
          "description": {
            "de": "string",
            "en": "string",
            "fr": "string",
            "es": "string",
            "pl": "string"
          },
          "type": {
            "id": "string",
            "name": "Mitarbeiter/in"
          }
        }
      ],
      "dynamicAttributes": [
        {
          "name": "EU",
          "value": "Max Mustermann (Bruder)",
          "type": "Text",
          "description": {
            "de": "string",
            "en": "string",
            "fr": "string",
            "es": "string",
            "pl": "string"
          }
        }
      ],
      "absences_count": 1,
      "regularWorkingTimes_count": 1,
      "employmentPeriods_count": 1,
      "internalRates_count": 1
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response-Felder

Name
username
Type
string
Description
Eindeutiger Anmeldename des Mitarbeiters, wird auch als seine Kennung in der API verwendet.
Name
firstname
Type
string
Description
Vorname des Mitarbeiters.
Name
lastname
Type
string
Description
Nachname des Mitarbeiters.
Name
personal_number
Type
string, nullable
Description
Personalnummer des Mitarbeiters, wie auf der Gehaltsabrechnung angegeben.
Name
street
Type
string, nullable
Description
Straße und Hausnummer der Adresse des Mitarbeiters.
Name
zip
Type
string, nullable
Description
Postleitzahl der Adresse des Mitarbeiters.
Name
city
Type
string, nullable
Description
Ort der Adresse des Mitarbeiters.
Name
country
Type
string, nullable
Description
Land der Adresse des Mitarbeiters.
Name
abbreviation
Type
string, nullable
Description
Kurzzeichen zur Identifikation des Mitarbeiters in kompakten Ansichten und Berichten.
Name
salutation
Type
object, nullable
Description
Anrede (Herr, Frau, …), die bei der Ansprache des Mitarbeiters verwendet wird.
Name
salutation.id
Type
string
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
salutation.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Herr", "Frau", ""
Name
title
Type
string, nullable
Description
Akademischer oder beruflicher Titel, sofern vorhanden.
Name
email
Type
string, nullable
Description
Geschäftliche E-Mail-Adresse, unter der der Mitarbeiter erreichbar ist und eingeladen wird.
Name
phone
Type
string, nullable
Description
Geschäftliche Festnetznummer.
Name
mobile
Type
string, nullable
Description
Geschäftliche Mobilnummer.
Name
fax
Type
string, nullable
Description
Geschäftliche Faxnummer.
Name
private_phone
Type
string, nullable
Description
Private Telefonnummer, getrennt von der geschäftlichen Telefonnummer geführt.
Name
birthdate
Type
string (date-time), nullable
Description
Geburtsdatum des Mitarbeiters.
Name
iban
Type
string, nullable
Description
IBAN (International Bank Account Number) für Erstattungen und Gehaltszahlungen.
Name
bic
Type
string, nullable
Description
BIC (Bank Identifier Code) der Bank des Mitarbeiters.
Name
account_no
Type
string, nullable
Description
Kontonummer, wird verwendet, wenn keine IBAN verfügbar ist.
Name
bank_name
Type
string, nullable
Description
Name der Bank des Mitarbeiters.
Name
bank_code
Type
string, nullable
Description
Bankleitzahl der Bank des Mitarbeiters.
Name
currency
Type
string, nullable
Description
Währung, in der die Stundensätze und Erstattungen des Mitarbeiters angegeben sind.
Name
approval_date
Type
string (date-time), nullable
Description
Datum, an dem die Daten/der Vertrag des Mitarbeiters genehmigt wurden.
Name
vat
Type
number, nullable
Description
Umsatzsteuersatz, der auf die abgerechneten Stundensätze des Mitarbeiters angewendet wird.
Name
price_group
Type
string
Description
Preisgruppe, aus der die Abrechnungssätze des Mitarbeiters abgeleitet werden.
Name
employment
Type
object, nullable
Description
Art der Beschäftigung (festangestellt, freiberuflich, …).
Name
employment.id
Type
string
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
employment.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Mitarbeiter/in", "Freier Mitarbeiter", "Freier Mitarbeiter mit Gutschrift"
Name
rights
Type
object
Description
Rechtestufe, die dem Mitarbeiter in der Anwendung gewährt wird.
Name
rights.id
Type
string
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
rights.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "User", "Administrator", "Controller", "User with additional authorizations", "Projektcontroller", "Kundenansprechpartner", "System-Administrator"
Name
department_id
Type
integer
Description
Kennung der Abteilung, der der Mitarbeiter derzeit angehört.
Name
language
Type
object, nullable
Description
Sprache, in der Oberfläche und Kommunikation für den Mitarbeiter angezeigt werden.
Name
language.locale
Type
string
Description
Name
language.isoCode
Type
string
Description
Einer der Werte: "de", "en", "fr", "es", "pl", "sk", "tr"
Name
language.name
Type
string
Description
Einer der Werte: "deutsch", "German (Austria)", "German (Switzerland)", "englisch", "English (German Format)", "English (Europe)", "English (Great Britain)", "English (USA)", "französisch", "French (Switzerland)", "French (German Format)", "Spanisch", "Polnisch", "Slovak", "Turkish"
Name
language.dateFormat
Type
string
Description
Einer der Werte: "d.m.Y", "d/m/Y", "m/d/Y"
Name
language.dateTimeFormat
Type
string
Description
Einer der Werte: "d.m.Y H:i", "d/m/Y H:i", "m/d/Y H:i"
Name
language.numberFormat
Type
object
Description
Name
personio_id
Type
string, nullable
Description
Kennung des Mitarbeiters im angebundenen Personio-HR-System, sofern verknüpft.
Name
cost_bearer
Type
string, nullable
Description
Kostenstelle, auf die Zeiten und Auslagen des Mitarbeiters gebucht werden.
Name
tax_id
Type
string, nullable
Description
Steueridentifikationsnummer des Mitarbeiters.
Name
created
Type
string (date-time), nullable
Description
Zeitstempel der Erstellung des Mitarbeiterdatensatzes.
Name
modified
Type
string (date-time), nullable
Description
Zeitstempel der letzten Änderung des Mitarbeiterdatensatzes.
Name
creditor_number
Type
string, nullable
Description
Kreditorennummer, die bei der Erstattung an den Mitarbeiter über die Buchhaltung verwendet wird.
Name
categories
Type
Liste von Category
Description
Kategorien, denen der Mitarbeiter zugeordnet ist.
Name
categories.name
Type
string
Description
Name der Kategorie, wird überall angezeigt, wo eine Entität damit gekennzeichnet ist.
Name
categories.description
Type
object
Description
Ausführlichere Erläuterung, wofür diese Kategorie verwendet werden soll.
Name
categories.type
Type
object
Description
Art der Entität, der diese Kategorie zugeordnet werden kann, z. B. Mitarbeiter, Projekt oder Kunde.
Name
dynamicAttributes
Type
Liste von DynamicAttribute
Description
Für diesen Mandanten konfigurierte dynamische Attribute, die bei diesem Mitarbeiter gesetzt sind.
Name
dynamicAttributes.name
Type
string
Description
Name der Definition des dynamischen Attributs, für die dieser Wert eingegeben wurde.
Name
dynamicAttributes.value
Type
any
Description
Der gespeicherte Wert; seine Form hängt vom benachbarten Feld type ab (eine Zeichenkette, eine Zahl, ein Boolean, ein Datum, eine Mitarbeiterreferenz oder eine Liste von Optionswerten).
Name
dynamicAttributes.type
Type
string
Description
Datentyp dieses Attributs, z. B. Text, Zahl, Datum oder Optionen; bestimmt, wie value zu interpretieren ist.
Einer der Werte: "Text", "Integer", "Float", "URL", "E-Mail", "Datum", "Uhrzeit", "Datetime", "Boolean", "Betrag", "Optionen", "Prozent", "Time period", "Textarea", "Users", "Upload"
Name
dynamicAttributes.description
Type
object, nullable
Description
Erläuterung, was dieses Attribut erfasst, wie in seiner Definition konfiguriert.
Name
absences_count
Type
integer
Description
Anzahl der für diesen Mitarbeiter erfassten Fehlzeiten.
Name
regularWorkingTimes_count
Type
integer
Description
Anzahl der für diesen Mitarbeiter erfassten Regelarbeitszeiten.
Name
employmentPeriods_count
Type
integer
Description
Anzahl der für diesen Mitarbeiter erfassten Beschäftigungszeiträume.
Name
internalRates_count
Type
integer
Description
Anzahl der für diesen Mitarbeiter erfassten internen Stundensätze.

Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.

Mitarbeiter GET Einzelnen Mitarbeiter abrufen