WorkersPeriod
Fetches details about the worker’s applicable pay periods, leave cycles, or reporting periods based on their employment schedule.
Workday Resource Information
Returns the period from the period schedule the worker is eligible for, on the given date. If you don't specify a date, today's date is used. This endpoint returns only 1 period.Secured by: Process: Time Tracking Configuration Objects REST APIs
Scope: Time Tracking
Columns
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the time entry period instance. |
| Workers_Id [KEY] | String | The Workday ID of the worker associated with this time entry period. |
| CloseTimeEntry | Datetime | Timestamp when the time entry period is closed for submissions. |
| Descriptor | String | A brief preview of the time entry period instance. |
| LockTimeEntry | Datetime | Timestamp when the time entry period is locked from further modifications. |
| OpenTimeEntry | Datetime | Timestamp when the time entry period is open for worker submissions. |
| PaymentDate | Datetime | The scheduled payment date for the payroll period or time tracking. |
| PeriodEndDate | Datetime | The end date of the payroll or absence subperiod. |
| PeriodStartDate | Datetime | The start date of the payroll or absence subperiod. |
| UnlockTimeEntry | Datetime | Timestamp when the time entry period is unlocked for adjustments. |
| Date_Prompt | Date | Filters results by eligibility date in yyyy-mm-dd format. Defaults to the current date if not provided. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |