Workday Payroll · Schema

WorkerCollection

WorkerCollection schema from Workday Payroll API

CompensationEnterpriseHuman ResourcesPayrollSaaSTax

Properties

Name Type Description
data array
total integer Total number of workers
View JSON Schema on GitHub

JSON Schema

payroll-worker-collection-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-payroll/refs/heads/main/json-schema/payroll-worker-collection-schema.json",
  "title": "WorkerCollection",
  "description": "WorkerCollection schema from Workday Payroll API",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/WorkerRef"
      }
    },
    "total": {
      "type": "integer",
      "description": "Total number of workers",
      "example": 52
    }
  },
  "$defs": {
    "WorkerRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Worker identifier",
          "example": "w_100542"
        },
        "descriptor": {
          "type": "string",
          "description": "Worker display name",
          "example": "Weekly USD Pay Group"
        }
      }
    }
  }
}