Workday · Schema

Worker

Cloud ComputingEnterprise SoftwareFinancial ManagementHCMSaaS

Properties

Name Type Description
id string The Workday ID of the worker.
descriptor string A display descriptor for the worker.
workerID string The employee or contingent worker ID.
primaryWorkEmail string
primaryWorkPhone string
businessTitle string
workerType object
primarySupervisoryOrganization object
location object
hireDate string The hire date for the worker.
terminationDate string The termination date, if applicable.
isManager boolean Whether the worker is a manager.
externalID string The external ID for the worker.
View JSON Schema on GitHub

JSON Schema

workday-worker-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Worker",
  "title": "Worker",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The Workday ID of the worker.",
      "example": "abc123"
    },
    "descriptor": {
      "type": "string",
      "description": "A display descriptor for the worker.",
      "example": "example_value"
    },
    "workerID": {
      "type": "string",
      "description": "The employee or contingent worker ID.",
      "example": "500123"
    },
    "primaryWorkEmail": {
      "type": "string",
      "format": "email",
      "example": "[email protected]"
    },
    "primaryWorkPhone": {
      "type": "string",
      "example": "example_value"
    },
    "businessTitle": {
      "type": "string",
      "example": "example_value"
    },
    "workerType": {
      "$ref": "#/components/schemas/ResourceReference"
    },
    "primarySupervisoryOrganization": {
      "$ref": "#/components/schemas/ResourceReference"
    },
    "location": {
      "$ref": "#/components/schemas/ResourceReference"
    },
    "hireDate": {
      "type": "string",
      "format": "date",
      "description": "The hire date for the worker.",
      "example": "2026-01-15"
    },
    "terminationDate": {
      "type": "string",
      "format": "date",
      "description": "The termination date, if applicable.",
      "example": "2026-01-15"
    },
    "isManager": {
      "type": "boolean",
      "description": "Whether the worker is a manager.",
      "example": true
    },
    "externalID": {
      "type": "string",
      "description": "The external ID for the worker.",
      "example": "500123"
    }
  }
}