v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Meal & Rest Breaks

Public API

List Break Policies

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

OAuth Scopes: time_tracking:breaks

get/api/v1/time-tracking/break-policies

Query parameters

offsetinteger

The offset of items to retrieve

limitinteger

The maximum items to retrieve

filterstring

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'.

includeCountsboolean

Include employee and break counts

Response

Successfully retrieved break policies

Example response

{
  "meta": {
    "totalItems": 3,
    "offset": 2,
    "limit": 2
  },
  "data": [
    {
      "id": "0199de9b-6bcb-77e7-941d-3caf74b9a372",
      "name": "California",
      "description": "All breaks for California compliance",
      "allEmployeesAssigned": true,
      "createdAt": "2025-10-15T06:00:00Z",
      "updatedAt": "2025-10-15T06:00:00Z",
      "deletedAt": "2025-10-15T06:00:00Z"
    }
  ]
}