List Time Off Policies

get

https://{companyDomain}.bamboohr.com/api/v1/time-off/policies

Lists time off policies, with support for filtering, sorting, and pagination. Each accruing policy includes its currently effective version with milestones inlined.

OAuth Scopes: time_off:policies

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter

string

OData filter expression applied to time off policies. Supported operators: eq (equals, use eq null to match NULL), ne (not equals, use ne null to match NOT NULL), lt (less than), le (less than or equal), gt (greater than), ge (greater than or equal), in (value in list), and (combine clauses). Not supported: or, not, parenthesized grouping. Filterable fields: id, name, categoryId, type, createdAt, updatedAt. Examples: type eq 'ACCRUING', categoryId in (22, 23), type eq 'ACCRUING' and name eq 'Standard Vacation'.

orderBy

string

Sort the results by a property and direction, e.g. name asc. Sortable fields: id, name, categoryId, type, createdAt, updatedAt.

page

integer

≥ 1

Defaults to 1

The page number to retrieve.

pageSize

integer

10 to 100

Defaults to 50

The number of items to return per page.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200A paginated list of time off policies.

422Invalid query parameters (e.g. invalid page, pageSize, orderBy, or an unsupported filter field or value).