TimeOffResponse

Paginated list of time off entries

Absence ManagementAttendanceEnterpriseHCMHuman Capital ManagementPayrollSchedulingTime TrackingTimesheetsWorkforce Management

Properties

Name Type Description
total integer
offset integer
limit integer
data array
View JSON Schema on GitHub

JSON Schema

absence-management-time-off-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-tracking-system/refs/heads/main/json-schema/absence-management-time-off-response-schema.json",
  "title": "TimeOffResponse",
  "description": "Paginated list of time off entries",
  "type": "object",
  "properties": {
    "total": { "type": "integer" },
    "offset": { "type": "integer" },
    "limit": { "type": "integer" },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "An employee time off entry",
        "properties": {
          "id": { "type": "string", "description": "Unique Workday ID of the time off entry" },
          "workerId": { "type": "string", "description": "Workday ID of the worker" },
          "timeOffType": { "type": "string", "description": "Type of time off (e.g., Vacation, Sick, Personal)", "example": "Vacation" },
          "startDate": { "type": "string", "format": "date", "description": "Start date of the time off", "example": "2026-05-10" },
          "endDate": { "type": "string", "format": "date", "description": "End date of the time off", "example": "2026-05-14" },
          "hours": { "type": "number", "format": "float", "description": "Total hours of time off", "example": 40.0 },
          "days": { "type": "number", "format": "float", "description": "Total days of time off", "example": 5.0 },
          "status": { "type": "string", "description": "Approval status of the time off request", "enum": ["Draft", "Submitted", "Approved", "Denied", "Cancelled"] },
          "comment": { "type": "string", "description": "Worker's note on the request" },
          "approverComment": { "type": "string", "description": "Manager's comment on approval/denial" },
          "createdAt": { "type": "string", "format": "date-time", "readOnly": true }
        },
        "required": ["workerId", "timeOffType", "startDate", "endDate"]
      }
    }
  }
}