improved
📘 Time Off API: Improved documentation
13 days ago
What's new?
As our time off request capabilities evolve, we've enhanced the GET Time off request by ID endpoint with improved field descriptions to better reflect the values that may be returned when retrieving a time off request.
These are documentation-only changes, with no impact on the actual API behavior. The goal is to better reflect the structure and values already returned in the response payload.
What's included
- Updated category title: The API category name has changed from Time & Attendance API to Time Off & Attendance API for clarity.
- Additional request types: The requestType field now reflects the wider range of values supporting more flexible time off options:
- days: The request spans X full days.
- hours: The request is for X hours during the day (applies only to policies measured in hours).
- portionOnRange: The request is for every morning or afternoon during the selected date range.
- hoursOnRange: The request is for X hours each day in the date range.
- differentDayDurations: The request is for a different number of hours on each day in the range.
- specificHoursDayDurations: The request is for specific hours per day.
- percentageOnRange: The request is for X% of each day in the date range.
- New durations field: Added a durations array to reflect granular time off requests that vary across the selected days.
To learn more, see Get the details of an existing time off request.