Workday Tracking System Worker Preferences API

openapi: 3.0.3
info:
  title: Workday Absence Management Accruals Worker Preferences API
  description: Track employee attendance, absences, leave requests, and time off balances in the Workday platform. Supports entering time off, requesting leave of absence, managing accrual balances, and processing return-from-leave events.
  version: v1
  contact:
    name: Workday Developer Support
    url: https://developer.workday.com
  x-generated-from: documentation
  x-last-validated: '2026-05-03'
servers:
- url: https://{tenant}.workday.com/api/absence-management/v1
  description: Workday tenant-specific Absence Management REST API
  variables:
    tenant:
      default: your-tenant
      description: Your Workday tenant identifier
security:
- BearerAuth: []
tags:
- name: Worker Preferences
  description: Operations for managing worker scheduling preferences
paths:
  /workers/{workerId}/schedulingPreferences:
    get:
      operationId: getWorkerSchedulingPreferences
      summary: Get Worker Scheduling Preferences
      description: Returns scheduling preferences for a worker.
      tags:
      - Worker Preferences
      parameters:
      - name: workerId
        in: path
        required: true
        description: The Workday ID of the worker
        schema:
          type: string
      responses:
        '200':
          description: Worker preferences retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkerSchedulingPreferences'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateWorkerSchedulingPreferences
      summary: Update Worker Scheduling Preferences
      description: Updates scheduling preferences for a worker.
      tags:
      - Worker Preferences
      parameters:
      - name: workerId
        in: path
        required: true
        description: The Workday ID of the worker
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkerSchedulingPreferencesInput'
      responses:
        '200':
          description: Worker preferences updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkerSchedulingPreferences'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request - invalid input
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    WorkerSchedulingPreferences:
      type: object
      description: A worker's scheduling preferences
      properties:
        workerId:
          type: string
          description: Workday ID of the worker
        preferredStartTime:
          type: string
          format: time
          description: Preferred shift start time
          example: 08:00:00
        preferredEndTime:
          type: string
          format: time
          description: Preferred shift end time
          example: '16:00:00'
        preferredDaysOff:
          type: array
          description: Preferred days off
          items:
            type: string
            enum:
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
            - Sunday
        maxHoursPerWeek:
          type: number
          format: float
          description: Maximum hours per week
          example: 40.0
        minHoursPerWeek:
          type: number
          format: float
          description: Minimum hours per week
          example: 32.0
        availability:
          type: object
          description: Worker availability by day of week
          additionalProperties:
            type: object
            properties:
              available:
                type: boolean
              startTime:
                type: string
                format: time
              endTime:
                type: string
                format: time
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
    WorkerSchedulingPreferencesInput:
      type: object
      description: Input for updating scheduling preferences
      properties:
        preferredStartTime:
          type: string
          format: time
        preferredEndTime:
          type: string
          format: time
        preferredDaysOff:
          type: array
          items:
            type: string
        maxHoursPerWeek:
          type: number
          format: float
        minHoursPerWeek:
          type: number
          format: float
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 Bearer token authentication