Read a list of who's out of the office today or on the specified date.

Returns the list of people that have a time off request today or on the specified date, only for the users the Service User can access.

Possible time off request types (requestRangeType):

• days: the request is for X full days.
• hours: the request is for X hours during the requested day (supported only for policy types measured in hours).
• portionOnRange: the request is for every morning or every afternoon during the requested days.
• hoursOnRange: the request is for X hours every day during the requested days.
• differentDayDurations: the request is for a different number of hours on each requested day.
• specificHoursDayDurations: the request is for specific hours per day.
• differentSpecificHoursDayDurations: the request is for different specific hours or portions on each day.
• percentageOnRange: the request is for X percent of every day during the requested days.
• openEnded: the request does not have an end date yet.

Each request type is represented by a separate schema with the relevant fields.

Durations and cost:

• This endpoint returns daily durations only for requests that use day-by-day duration configurations, including: DifferentDayDurations, specificHoursDayDurations, differentSpecificHoursDayDurations.
• These durations do not include a daily cost breakdown.
• All requests return totalCost, which represents the amount deducted from the balance for the whole request.
• To retrieve the cost per day, use Get the details of an existing time off request. with includeDailyDurations=true.

Notes:

• Permissions: Follow the Time off API Required Permissions instructions to ensure the service user has the required permissions.
• Parameters: The data returned is also subject to parameters and the permissions granted to the Service User. Make sure you set the relevant permissions when using the 'includePending' flag.