List Who's Out

get

https://{companyDomain}.bamboohr.com/api/v1/whos-out

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start

date

required

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

end

date

required

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

filter

string

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.

directReportsOnly

boolean

Defaults to false

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

includePersons

boolean

Defaults to false

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

page

integer

≥ 1

Defaults to 1

The page number to retrieve.

pageSize

integer

10 to 100

Defaults to 100

The number of items to return per page.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A paginated list of approved time off occurrences.

401Unauthorized. Missing or invalid authentication.

403Forbidden. Missing the time_off scope.

422Invalid query parameters (e.g. missing or malformed start/end, end before start, range over 366 days, pageSize outside 10-100, or an unsupported filter field).