The maximum number of balance records to return in a single response. Default is 20, maximum is 100.
offsetinteger
The zero-based index of the first record to return. Default is 0. Use with limit for pagination.
workerstring
The Workday ID of the worker whose balances should be returned. If not specified, returns balances for all accessible workers.
categorystring
The Workday ID of the Time Off, Leave Type, or Absence Table to filter by. This is a 32-character hexadecimal ID (e.g., '8cdc5bb54494100018789cabb3df006d'). If not specified, returns balances for all categories.
effectivestring
Return absence balances as of the specified date in yyyy-mm-dd format (e.g., '2025-12-31'). If not specified, returns current balances.
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not