UKG · Schema

Employee

Employee record with demographic and employment information

Human Capital ManagementHCMWorkforce ManagementHRPayrollTime and AttendanceBenefitsScheduling

Properties

Name	Type	Description
employeeId	string	Unique employee identifier
firstName	string	Employee first name
lastName	string	Employee last name
email	string	Work email address
employmentStatus	string	Current employment status
hireDate	string	Original hire date
departmentId	string	Department identifier
locationId	string	Work location identifier
jobTitle	string	Current job title
managerId	string	Manager employee identifier

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ukg/refs/heads/main/json-schema/pro-hcm-employee-schema.json",
  "title": "Employee",
  "description": "Employee record with demographic and employment information",
  "type": "object",
  "properties": {
    "employeeId": {
      "type": "string",
      "description": "Unique employee identifier",
      "example": "EMP001"
    },
    "firstName": {
      "type": "string",
      "description": "Employee first name",
      "example": "Jane"
    },
    "lastName": {
      "type": "string",
      "description": "Employee last name",
      "example": "Smith"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Work email address",
      "example": "[email protected]"
    },
    "employmentStatus": {
      "type": "string",
      "description": "Current employment status",
      "example": "Active",
      "enum": [
        "Active",
        "Inactive",
        "Terminated",
        "Leave"
      ]
    },
    "hireDate": {
      "type": "string",
      "format": "date",
      "description": "Original hire date",
      "example": "2022-06-01"
    },
    "departmentId": {
      "type": "string",
      "description": "Department identifier",
      "example": "DEPT-HR"
    },
    "locationId": {
      "type": "string",
      "description": "Work location identifier",
      "example": "LOC-NYC"
    },
    "jobTitle": {
      "type": "string",
      "description": "Current job title",
      "example": "Senior HR Analyst"
    },
    "managerId": {
      "type": "string",
      "description": "Manager employee identifier",
      "example": "EMP042"
    }
  }
}