Employee Employment Details

Retrieve employee employment details

Get comprehensive employment information including job details, employment status, and work history.

This endpoint provides access to the employee's current employment details and reporting structure.

get/v1/employees/{employeeId}/employment

Path parameters

employeeIdstring uuid required

Unique identifier for the employee

Response

Employee employment details retrieved successfully

employeeCodestring nullable

Human-readable employee code (optional)

employeeIdstring nullable

Deprecated: Use employeeCode instead. Human-readable employee code (optional)

workEmailstring email nullable

Employee's work email address

entitystring nullable

Legal entity name for the employee's employment

countrystring nullable

ISO 3166-1 alpha-3 country code for the employee's country of employment

startDatestring date

Date when employee joined the company (YYYY-MM-DD)

Current employment status

endDatestring date nullable

Date when employee left or will leave the company (optional)

designationstring

Job title or position

departmentstring nullable

Department name (optional)

type'EMPLOYEE' | 'HR_MEMBER' | 'FREELANCER' | 'CONTRACTOR' | 'UNKNOWN'

Type of employment

term'FIXED' | 'PERMANENT' | 'UNKNOWN'

Employment term (fixed-term or permanent)

Example response

{
  "employeeCode": "EMP-12345",
  "employeeId": "EMP-12345",
  "workEmail": "john.doe@company.com",
  "entity": "Tech Corp Singapore Pte Ltd",
  "country": "SGP",
  "startDate": "2023-01-15",
  "status": "ACTIVE",
  "designation": "Software Engineer",
  "department": "Engineering",
  "type": "EMPLOYEE",
  "term": "PERMANENT",
  "noticePeriod": {
    "value": "3",
    "unit": "MONTHS"
  },
  "exitDetails": {
    "type": "RESIGNATION",
    "reason": "Better opportunity",
    "dateOfTermination": "2024-12-31"
  },
  "reportsTo": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "firstName": "Jane",
    "lastName": "Smith",
    "designation": "Engineering Manager"
  }
}