DocumentationAPI Reference
API Reference

List Calendar Events

get
https://{companyDomain}.bamboohr.com/api/v1/calendar-events

Lists calendar events (time off, holidays, birthdays, and anniversaries) overlapping the requested date range. Events are sorted by start ascending, then type ascending (ANNIVERSARY, BIRTHDAY, HOLIDAY, TIME_OFF), then id ascending. TIME_OFF events represent approved requests only. Events the caller cannot view are silently omitted.

OAuth Scopes: calendar:events

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date
required

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

date
required

Inclusive end date (YYYY-MM-DD). Must be on or after start; the range must span less than one year.

string

OData filter expression applied to calendar events. Supported operators: eq (equals), in (value in list), and (combine clauses). Filterable fields: type (one of TIME_OFF, HOLIDAY, BIRTHDAY, ANNIVERSARY), employeeId (int), department (int), division (int), location (int). Per-employee filters have no effect on HOLIDAY events. Example: type in ('TIME_OFF','HOLIDAY') and department in (10,20).

boolean
Defaults to false

When true, restrict employee-bound events to the caller's direct reports. HOLIDAY events are unaffected. Callers with no direct reports receive an empty result for employee-bound types.

boolean
Defaults to false

When true, embed a persons map (keyed by employee id) alongside the events.

integer
≥ 1
Defaults to 1

The page number to retrieve.

integer
10 to 100
Defaults to 100

The number of items to return per page.

Responses

Updated about 3 hours ago

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago