Time Off
Public API

Lists approved time off occurrences overlapping the requested date range, scoped to employees the caller can see. Results the caller lacks permission to view are silently excluded. Dates are interpreted in the company timezone. Results are sorted by start date ascending, then id ascending.

OAuth Scopes: time_off

get/api/v1/whos-out

Request

Query parameters

startstring date required

Inclusive start date (YYYY-MM-DD). Interpreted in the company timezone.

endstring date required

Inclusive end date (YYYY-MM-DD). Must be on or after start; the range may not exceed 366 days.

filterstring

OData filter expression applied to who's out results. Supported operators: eq (equals), in (value in list), and (combine clauses). Filterable fields: employeeId (int), department (int), division (int), location (int). Examples: employeeId eq 42, department in (10, 20) and location eq 5.

directReportsOnlyboolean

When true, restrict to time off for the caller's direct reports. Callers with no direct reports receive an empty result.

includePersonsboolean

When true, embed a persons map of employee display data alongside results.

pageinteger

The page number to retrieve.

pageSizeinteger

The number of items to return per page.

Response

A paginated list of approved time off occurrences.

personsobject

Employee display data keyed by employee id. Present only when includePersons=true.

Example response

{
  "data": [
    {
      "id": "12345",
      "employeeId": 42,
      "timeOffTypeId": 7,
      "start": "2026-05-04",
      "end": "2026-05-08"
    }
  ]
}

Changes