List Breaks for Break Policy

Returns a paginated list of breaks belonging to the specified break policy. Supports OData v4 filtering.

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

The break policy ID.

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 breaks within the policy. 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, paid, duration, availabilityType, availabilityMinHoursWorked, availabilityMaxHoursWorked, availabilityStartTime, availabilityEndTime, createdAt, updatedAt, deletedAt. Examples: name eq 'Lunch', paid eq true, paid eq false and name ne 'Quick Break'.

Responses

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