v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBList Breaks for Break Policy
Returns a paginated list of breaks belonging to the specified break policy. Supports OData v4 filtering.
OAuth Scopes: time_tracking:breaks
Path parameters
The break policy ID.
Query parameters
The offset of items to retrieve
The maximum items to retrieve
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'.
Response
Successfully retrieved breaks for the specified break policy
Example response
{
"meta": {
"totalItems": 3,
"offset": 2,
"limit": 2
},
"data": [
{
"id": "0199de9b-6bcb-77e7-941d-3caf74b9a372",
"name": "Lunch Break",
"duration": 60,
"availabilityStartTime": "08:00",
"availabilityEndTime": "17:00",
"createdAt": "2025-01-01T06:00:00Z",
"updatedAt": "2025-01-01T06:00:00Z",
"deletedAt": "2025-01-01T06:00:00Z"
}
]
}