DocumentationAPI Reference
API Reference

List Break Policies

get
https://{companyDomain}.bamboohr.com/api/v1/time-tracking/break-policies

Returns a paginated list of all break policies. Supports OData v4 filtering. Use includeCounts to include employee and break counts per policy.

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

The offset of items to retrieve

integer
≤ 500
Defaults to 100

The maximum items to retrieve

string

OData filter expression applied to break 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, description, allEmployeesAssigned, createdAt, updatedAt, deletedAt. Examples: name eq 'Standard Lunch', description eq null, allEmployeesAssigned eq true and name ne 'Legacy'.

boolean
Defaults to false

Include employee and break counts

Responses

Updated about 1 month 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 1 month ago