DocumentationAPI Reference
API Reference

List Time Off Requests

get
https://{companyDomain}.bamboohr.com/api/v1/time_off/requests

Returns time off requests within the specified date range. Both start and end query parameters are required (YYYY-MM-DD). The search is inclusive: requests whose date range overlaps the query window are returned. Results can be filtered by status, employee, time off type, or limited to requests the caller can approve.

OAuth Scopes: time_off

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

A particular request ID to limit the response to.

string
enum
Defaults to view

Limit to requests the caller can view, requests they can approve, or only their own requests via myRequests. Defaults to view.

Allowed:
string

A particular internal employee ID to limit the response to.

date
required

The left boundary of the search window, in YYYY-MM-DD format. Returns any request whose end date falls on or after this date — i.e., requests that are still active at the start of your window. To find all requests overlapping a date range, pass your range start here. Note: this parameter filters on each request's end date, not its start date.

date
required

The right boundary of the search window, in YYYY-MM-DD format. Returns any request whose start date falls on or before this date — i.e., requests that have begun by the end of your window. To find all requests overlapping a date range, pass your range end here. Note: this parameter filters on each request's start date, not its end date.

string

A comma-separated list of time off type IDs to filter by. If omitted, requests of all types are included.

string

A comma-separated list of request status values to filter by. Accepted values are approved, denied, superceded, requested, and canceled. If omitted, requests of all statuses are included.

string

When set to any truthy value, omits the notes object from each request in the response.

Headers
string
enum

This endpoint can produce either JSON or XML.

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized. Invalid API credentials.

Updated 3 months 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 3 months ago