UKG · Schema

EmployeeList

Paginated list of employee records

Human Capital ManagementHCMWorkforce ManagementHRPayrollTime and AttendanceBenefitsScheduling

Properties

Name Type Description
employees array
total integer Total number of records
page integer Current page
View JSON Schema on GitHub

JSON Schema

pro-hcm-employee-list-schema.json Raw ↑ 
{
  "$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-list-schema.json",
  "title": "EmployeeList",
  "description": "Paginated list of employee records",
  "type": "object",
  "properties": {
    "employees": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Employee"
      },
      "example": "example-value"
    },
    "total": {
      "type": "integer",
      "description": "Total number of records",
      "example": 1
    },
    "page": {
      "type": "integer",
      "description": "Current page",
      "example": 1
    }
  }
}