Skip to main content
Das folgende Schema wird direkt aus dem veröffentlichten OpenAPI-3.1-Vertrag gerendert. Eigenschaftsnamen, Typen, Enums und technische Beschreibungen bleiben Bestandteil des maßgeblichen englischen API-Vertrags.

Employee details.

id
string
erforderlich
read-only

Unique employee identifier.

Pattern: ^[0-9a-fA-F]{24}$
Beispiel:

"68a000000000000000000001"

email
string<email>
erforderlich

Work email address used by the employee account. This field is not editable through the update endpoint.

Beispiel:

"alex.morgan@example.com"

blocked
boolean
erforderlich

Whether the employee account is blocked.

Beispiel:

false

tenant
string | null
erforderlich
nullable

Tenant identifier, or null if the employee has no tenant assignment.

Minimum string length: 1
Pattern: ^[0-9a-fA-F]{24}$
Beispiel:

"68a000000000000000000010"

divisionId
string | null
erforderlich
nullable

Assigned division identifier, or null when no division is assigned.

Minimum string length: 1
Pattern: ^[0-9a-fA-F]{24}$
Beispiel:

"68920e08eeaea4f2301eecb3"

createdAt
string<date-time>
erforderlich
read-only

UTC timestamp at which the employee record was created.

Minimum string length: 1
Pattern: Z$
Beispiel:

"2026-06-01T08:00:00.000Z"

updatedAt
string<date-time>
erforderlich
read-only

UTC timestamp of the latest employee update.

Minimum string length: 1
Pattern: Z$
Beispiel:

"2026-07-15T11:30:00.000Z"

privateEmail
string | null
nullable
optional

Optional private email address, or null when none is stored.

Beispiel:

"alex.morgan.private@example.net"

employeeNumber
string | null
nullable
optional

Customer-defined personnel or employee number, or null when none is assigned.

Beispiel:

"EMP-1042"

firstName
string | null
nullable
optional

Employee first name, or null when unavailable in an existing record.

Beispiel:

"Alex"

lastName
string | null
nullable
optional

Employee last name, or null when unavailable in an existing record.

Beispiel:

"Morgan"

phoneNumber
string | null
nullable
optional

Employee phone number, or null when none is stored.

Beispiel:

"+49 221 5550100"

street
string | null
nullable
optional

Street and house number, or null when no address is stored.

Beispiel:

"Example Street 12"

postalCode
string | null
nullable
optional

Postal code, or null when no address is stored.

Beispiel:

"50667"

city
string | null
nullable
optional

City, or null when no address is stored.

Beispiel:

"Cologne"

countryCode
string | null
nullable
optional

Uppercase two-character country or territory code, or null when no address is stored.

Beispiel:

"DE"

additionalInfo
string | null
nullable
optional

Additional employee or address information, or null when none is stored.

Beispiel:

"Building B, third floor"

Zuletzt geändert am 27. August 2026