List Time Off Policy Versions

get

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

Lists a time off policy's rate-table versions, with each version's milestones inlined. Ordered by effective date descending, most recent first, with a secondary ordering by version id so paging stays stable when two versions share an effective date. Both currently effective and superseded (archived) versions are returned; versions the server discarded when a schedule was re-saved are not. Unlimited and manual policies have no accrual schedule, so they return an empty list.

OAuth Scopes: time_off:policies

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The time off policy ID.

Query Params

filter

string

OData filter expression applied to the policy's versions. 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: versionId (matches the version id), effectiveDate, status. Examples: status eq 'ARCHIVED', effectiveDate ge '2026-01-01', versionId in (10, 11). Note that a version with no effective date stores a zero date rather than NULL, so effectiveDate eq null never matches.

page

integer

≥ 1

Defaults to 1

The page number to retrieve. Rejected when the resulting offset would exceed the largest supported integer.

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 the policy's versions.

401Unauthorized. The credentials are missing or invalid.

403Forbidden. The authenticated user may not view this time off policy.

404The time off policy does not exist.

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