v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Time Off

Public API

List Who’s Out

Returns a date-sorted list of employees who are out and company holidays for the specified period. Defaults to today through 14 days out when dates are omitted. Results include both timeOff entries (employee requests) and holiday entries, each identified by type. An empty array may mean no one is out, or that no holidays have been configured in the BambooHR company calendar — holidays must be set up there before they appear here. The filter: off parameter applies only to employee time-off entries; holidays are independently filtered per-employee based on holiday visibility settings, and that filter is not disabled by filter: off.

OAuth Scopes: time_off

get/api/v1/time_off/whos_out

Query parameters

startstring date

Start date in YYYY-MM-DD format. Defaults to today.

endstring date

End date in YYYY-MM-DD format. Defaults to 14 days after the start date.

filter'off'

Controls the Who's Out calendar filter. By default (parameter omitted), results are limited to the set of employees defined by the authenticated user's saved Who's Out calendar filter (the same filter applied to their in-app Who's Out view). A user with no filter configured sees all employees; a user with a saved filter (e.g. by department, location, division) sees only the configured subset. Set to off to ignore the saved filter and return employee time-off entries for everyone — useful for admins or integrations that need the complete company-wide view, or to diagnose whether incomplete results are caused by the saved filter. Note: this parameter applies to employee timeOff entries only. holiday entries are filtered separately on a per-employee basis (holidays can be configured as visible to specific employees) and that filter is not affected by filter: off.

Headers

AcceptHeaderParameter'application/xml' | 'application/json'

This endpoint can produce either JSON or XML.

Response

A date-sorted list of employees who are out and company holidays.

idinteger

The time off request ID or holiday ID.

type'timeOff' | 'holiday'

Whether this entry is a time off request or a company holiday. Entries have two shapes depending on type: timeOff entries include employeeId and name (the employee's name); holiday entries include only name (the holiday name) and omit employeeId. Always check type before accessing employeeId.

employeeIdinteger

The internal employee ID. Only present for timeOff entries; omitted for holiday entries.

namestring

For timeOff entries, the employee's name. For holiday entries, the holiday's name.

startstring date

Start date in YYYY-MM-DD format.

endstring date

End date in YYYY-MM-DD format.