v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBList Break Assessments
Returns a paginated list of break assessments. A break assessment records whether an employee complied with their assigned break policy for a given day, along with any violations. Use the filter parameter to scope results by employee, date, result, or other fields. Use offset and limit for pagination; limit defaults to 100 and may not exceed 500.
OAuth Scopes: time_tracking:breaks
Query parameters
Number of items to skip before returning results. Defaults to 0.
Maximum number of items to return. Defaults to 100. Maximum is 500.
OData filter expression applied to break assessments. 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, breakId, employeeId, employeeTimesheetId, date, result, availableYmdt, unavailableYmdt, expectedDuration, recordedDuration, durationDifference, createdAt, updatedAt. Examples: employeeId eq 614, employeeId in (614, 615, 616), breakId eq 'abc-123' and employeeId eq 614.
Response
A list of paginated break assessments
Example response
{
"meta": {
"totalItems": 3,
"offset": 2,
"limit": 2
},
"data": [
{
"id": "0199de9b-6bcb-77e7-941d-3caf74b9a372",
"breakId": "4983000f-b8cd-436a-bbf0-574cfd7a8517",
"employeeId": 40342,
"employeeTimesheetId": 123,
"date": "2025-01-01",
"timezone": "America/Los_Angeles",
"availableYmdt": "2025-01-01T06:00:00Z",
"unavailableYmdt": "2025-01-01T06:00:00Z",
"createdAt": "2025-01-01T06:00:00Z",
"updatedAt": "2025-01-01T06:00:00Z",
"violations": [
{
"assessmentId": "21e369e9-295c-41fd-8973-08ee3b54f1a6",
"employeeTimesheetClockEntryId": 101,
"amount": 101
}
],
"expectedDuration": 15,
"recordedDuration": 10,
"durationDifference": -5
}
]
}