---
title: "Read a list of who's out of the office today or on the specified date."
method: GET
path: "/timeoff/outtoday"
tags: ["Time off requests"]
---

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

`GET /timeoff/outtoday`

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.<br /><br />
<b>Possible time off request types (<code>requestRangeType</code>):</b> <ul>
  <li><b>days</b>: the request is for X full days.</li>
  <li>
    <b>hours</b>: the request is for X hours during the requested day
    (supported only for policy types measured in hours).
  </li>
  <li>
    <b>portionOnRange</b>: the request is for every morning or every afternoon
    during the requested days.
  </li>
  <li>
    <b>hoursOnRange</b>: the request is for X hours every day during the
    requested days.
  </li>
  <li>
    <b>differentDayDurations</b>: the request is for a different number of
    hours on each requested day.
  </li>
  <li>
    <b>specificHoursDayDurations</b>: the request is for specific hours per day.
  </li>
  <li>
    <b>differentSpecificHoursDayDurations</b>: the request is for different
    specific hours or portions on each day.
  </li>
  <li>
    <b>percentageOnRange</b>: the request is for X percent of every day during
    the requested days.
  </li>
  <li><b>openEnded</b>: the request does not have an end date yet.</li>
</ul> Each request type is represented by a separate schema with the relevant fields.
<p><strong>Durations and cost:</strong></p> <ul>
  <li>
    This endpoint returns daily durations only for requests that use day-by-day duration configurations, including:
    <code>DifferentDayDurations</code>, <code>specificHoursDayDurations</code>, <code>differentSpecificHoursDayDurations</code>.
  </li>
  <li>These durations do not include a daily cost breakdown.</li>
  <li>
    All requests return <code>totalCost</code>, which represents the amount deducted from the balance for the whole request.
  </li>
  <li>
    To retrieve the cost per day, use <strong><a href="https://apidocs.hibob.com/reference/get_timeoff-employees-id-requests-requestid">Get the details of an existing time off request.</a></strong> with
    <code>includeDailyDurations=true</code>.
  </li>
</ul>
<p><b>Notes:</b></p> <ul> <li><b>Permissions</b>: Follow the <a href="https://apidocs.hibob.com/reference/time-off#required-permissions">Time off API Required Permissions</a> instructions to ensure the service user has the required permissions. </li> <li><b>Parameters</b>: 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.</li> </ul>

## Query parameters

- `today` string, date
- `includeHourly` boolean
- `includePrivate` boolean
- `siteId` integer

## Response `200`

The list of people who have taken time off, as seen by the logged in user.

- TimeOffOutTodayResponse
  - `outs` TimeOffOutToday[], required
    - union
      - TimeOffOutTodayDays
        - `employeeId` string, uuid — Employee ID.
        - `employeeDisplayName` string — Employee display name.
        - `employeeEmail` string — Employee email address.
        - `policyTypeDisplayName` string — Display name of the policy type.
        - `startDate` string, date — Date of the first day of the time off.
        - `visibility` Visibility — unresolved $ref
        - `endDate` string, date — Date of the last day of the time off. May be null for open ended requests.
        - `startDatePortion` string — What portion of the first day is included - all_day, morning or afternoon (relevant for request using the days type).
        - `endDatePortion` string — What portion of the last day is included - all_day, morning or afternoon (relevant for request using the days type).
        - `startPortion` string — What portion of the first day is included - all_day, morning or afternoon (relevant for request using the days type).
        - `endPortion` string — What portion of the last day is included - all_day, morning or afternoon (relevant for requests using the days type).
        - `requestRangeType` 'days' — The type of request - <b>days</b> is when the request is for X days.<br>
      - TimeOffOutTodayHours
        - `employeeId` string, uuid — Employee ID.
        - `employeeDisplayName` string — Employee display name.
        - `employeeEmail` string — Employee email address.
        - `policyTypeDisplayName` string — Display name of the policy type.
        - `startDate` string, date — Date of the first day of the time off.
        - `visibility` Visibility — unresolved $ref
        - `hours` integer — The time off duration in hours for the date (relevant for requests with hours type).
        - `minutes` integer — Relevant for requests using the hours type.
        - `requestRangeType` 'hours' — The type of request - <b>hours</b> is when the request is for X hours during the day requested (supported only for policy types measured in hours).<br>
      - TimeOffOutTodayPortionOnRange
        - `employeeId` string, uuid — Employee ID.
        - `employeeDisplayName` string — Employee display name.
        - `employeeEmail` string — Employee email address.
        - `policyTypeDisplayName` string — Display name of the policy type.
        - `startDate` string, date — Date of the first day of the time off.
        - `visibility` Visibility — unresolved $ref
        - `endDate` string, date — Date of the last day of the time off. May be null for open ended requests.
        - `dayPortion` string — What portion of the request's days is included - morning or afternoon (relevant for request using the portionOnRange type).
        - `requestRangeType` 'portionOnRange' — The type of request - <b>portionOnRange</b> is when the request is for every morning or every afternoon during the days requested.<br>
      - TimeOffOutTodayHoursOnRange
        - `employeeId` string, uuid — Employee ID.
        - `employeeDisplayName` string — Employee display name.
        - `employeeEmail` string — Employee email address.
        - `policyTypeDisplayName` string — Display name of the policy type.
        - `startDate` string, date — Date of the first day of the time off.
        - `visibility` Visibility — unresolved $ref
        - `endDate` string, date — Date of the last day of the time off. May be null for open ended requests.
        - `dailyHours` number — The time off duration in hours for every request's days (relevant for requests with hoursOnRange type).
        - `requestRangeType` 'hoursOnRange' — The type of request - <b>hoursOnRange</b> is when the request is for X hours every day during the days requested.<br>
      - TimeOffOutTodayDifferentDayDurations
        - `employeeId` string, uuid — Employee ID.
        - `employeeDisplayName` string — Employee display name.
        - `employeeEmail` string — Employee email address.
        - `policyTypeDisplayName` string — Display name of the policy type.
        - `startDate` string, date — Date of the first day of the time off.
        - `visibility` Visibility — unresolved $ref
        - `endDate` string, date — Date of the last day of the time off. May be null for open ended requests.
        - `durations` object[] — Array of durations for each day in the request.
          - `date` string, date
          - `dayDuration` HoursAndMinutesDayDuration — Duration in hours and minutes for a day (relevant for `differentDayDurations` type)
            - `hours` integer, required — Number of hours
            - `minutes` integer, required — Number of minutes (must match the minimal amount of minutes in the time off policy)
            - `dayDurationType` 'hoursAndMinutesDayDuration', required — Type of day duration
        - `requestRangeType` 'differentDayDurations' — The type of request - <b>differentDayDurations</b> is when the request is for a different amount of hours on each of the days requested.<br>
      - TimeOffOutTodaySpecificHoursDayDurations
        - `employeeId` string, uuid — Employee ID.
        - `employeeDisplayName` string — Employee display name.
        - `employeeEmail` string — Employee email address.
        - `policyTypeDisplayName` string — Display name of the policy type.
        - `startDate` string, date — Date of the first day of the time off.
        - `visibility` Visibility — unresolved $ref
        - `endDate` string, date — Date of the last day of the time off. May be null for open ended requests.
        - `timeZone` string — The calculated time zone name. The value for this fields is automatically determined based on the time zone of the employee’s assigned site.
        - `durations` object[] — Array of durations for each day in the request.
          - `date` string, date
          - `dayDuration` object
            - `localStartTime` string
            - `localEndTime` string
            - `dayDurationType` 'specificHoursDayDuration'
        - `requestRangeType` 'specificHoursDayDurations' — The type of request - <b>specificHoursDayDurations</b> is when the request is for specific hours per day.<br>
      - TimeOffOutTodayDifferentSpecificHoursDayDurations
        - `employeeId` string, uuid — Employee ID.
        - `employeeDisplayName` string — Employee display name.
        - `employeeEmail` string — Employee email address.
        - `policyTypeDisplayName` string — Display name of the policy type.
        - `startDate` string, date — Date of the first day of the time off
        - `visibility` Visibility — unresolved $ref
        - `endDate` string, date — Date of the last day of the time off.
        - `timeZone` string — The time zone for the time off request
        - `durations` object[] — Array of day durations for the time off request
          - `date` string, date, required — The date for this duration entry
          - `dayDuration` union, required — The duration for this specific date. Each date must include exactly one of the following types: <ul> <li>SpecificHoursDayDuration</li> <li>PortionDayDuration</li> </ul>
            - SpecificHoursDayDuration — Defines the request by exact working hours (for example, 10:00-12:00).
              - …
            - DiffSpecHoursPortionDayDuration — Defines the request as either the entire day (all_day) or no hours at all (vacant).
              - …
        - `requestRangeType` 'differentSpecificHoursDayDurations'
      - TimeOffOutTodayPercentageOnRange
        - `employeeId` string, uuid — Employee ID.
        - `employeeDisplayName` string — Employee display name.
        - `employeeEmail` string — Employee email address.
        - `policyTypeDisplayName` string — Display name of the policy type.
        - `startDate` string, date — Date of the first day of the time off.
        - `visibility` Visibility — unresolved $ref
        - `endDate` string, date — Date of the last day of the time off. May be null for open ended requests.
        - `percentageOfDay` integer — The percentage of day requested
        - `requestRangeType` 'percentageOnRange' — The type of request <b>percentageOnRange</b> is when the request is for X percent of every day during the days requested.
      - TimeOffOutTodayOpenEnded
        - `employeeId` string, uuid — Employee ID.
        - `employeeDisplayName` string — Employee display name.
        - `employeeEmail` string — Employee email address.
        - `policyTypeDisplayName` string — Display name of the policy type.
        - `startDate` string, date — Date of the first day of the time off.
        - `visibility` Visibility — unresolved $ref
        - `endDate` string, date, nullable — Date of the last day of the time off (may be null for open-ended requests).
        - `startDatePortion` string — What portion of the first day is included - all_day, morning or afternoon (relevant for request using the days type).
        - `endDatePortion` string, nullable — What portion of the last day is included - all_day, morning or afternoon (may be null for open-ended requests).
        - `startPortion` string — What portion of the first day is included - all_day, morning or afternoon (relevant for request using the days type).
        - `endPortion` string — What portion of the last day is included - all_day, morning or afternoon (relevant for requests using the days type).
        - `timeZone` string — The calculated time zone name. The value for this fields is automatically determined based on the time zone of the employee’s assigned site.
        - `requestRangeType` 'openEnded' — The type of request - <b>openEnded</b> is when the request doesn't have an end date yet.

## Other responses

- `default` — Unexpected error

---

[API](https://skmtc.net/hibob/apis/employee-data-api.md) · [All operations](https://skmtc.net/hibob/apis/employee-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hibob/employee-data-api/revisions/0781ebbdda91/schema)