Employee

The schema below is rendered directly from the published OpenAPI 3.1 contract.

Employee details.

string

required

read-only

Unique employee identifier.

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

Example:

"68a000000000000000000001"

string<email>

required

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

Example:

"alex.morgan@example.com"

blocked

boolean

required

Whether the employee account is blocked.

Example:

false

tenant

string | null

required

nullable

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

Minimum string length: 1

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

Example:

"68a000000000000000000010"

divisionId

string | null

required

nullable

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

Minimum string length: 1

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

Example:

"68920e08eeaea4f2301eecb3"

createdAt

string<date-time>

required

read-only

UTC timestamp at which the employee record was created.

Minimum string length: 1

Pattern: Z$

Example:

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

updatedAt

string<date-time>

required

read-only

UTC timestamp of the latest employee update.

Minimum string length: 1

Pattern: Z$

Example:

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

privateEmail

string | null

nullable

optional

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

Example:

"alex.morgan.private@example.net"

employeeNumber

string | null

nullable

optional

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

Example:

"EMP-1042"

firstName

string | null

nullable

optional

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

Example:

"Alex"

lastName

string | null

nullable

optional

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

Example:

"Morgan"

phoneNumber

string | null

nullable

optional

Employee phone number, or null when none is stored.

Example:

"+49 221 5550100"

street

string | null

nullable

optional

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

Example:

"Example Street 12"

postalCode

string | null

nullable

optional

Postal code, or null when no address is stored.

Example:

"50667"

city

string | null

nullable

optional

City, or null when no address is stored.

Example:

"Cologne"

countryCode

string | null

nullable

optional

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

Example:

"DE"

additionalInfo

string | null

nullable

optional

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

Example:

"Building B, third floor"

Overview

Data Models

Specification