List Who's Out
Changed onLists 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
Request
- Base URLhttps://companySubDomain.bamboohr.com
- Auth
- HTTP basic
- or OAuth 2Authorization code/authorize.phpToken URL/token.phpScopestime_off
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Inclusive start date (YYYY-MM-DD). Interpreted in the company timezone.
Inclusive end date (YYYY-MM-DD). Must be on or after start; the range may not exceed 366 days.
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.
When true, restrict to time off for the caller's direct reports. Callers with no direct reports receive an empty result.
When true, embed a persons map of employee display data alongside results.
The page number to retrieve.
The number of items to return per page.
Response
A paginated list of approved time off occurrences.
Example response
{
"data": [
{
"id": "12345",
"employeeId": 42,
"timeOffTypeId": 7,
"start": "2026-05-04",
"end": "2026-05-08"
}
]
}Changes
- info
endpoint added
- info