UKG · JSON Structure

Pro Hcm Employee List Structure

Paginated list of employee records

Type: object Properties: 3
Human Capital ManagementHCMWorkforce ManagementHRPayrollTime and AttendanceBenefitsScheduling

EmployeeList is a JSON Structure definition published by UKG, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

employees total page

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ukg/refs/heads/main/json-structure/pro-hcm-employee-list-structure.json",
  "name": "EmployeeList",
  "description": "Paginated list of employee records",
  "type": "object",
  "properties": {
    "employees": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Employee"
      },
      "example": "example-value"
    },
    "total": {
      "type": "int32",
      "description": "Total number of records",
      "example": 1
    },
    "page": {
      "type": "int32",
      "description": "Current page",
      "example": 1
    }
  }
}