v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Meal & Rest Breaks

Public API

Sync Break Policy

Performs a full replacement of a break policy and its related data (breaks and employee assignments). Unlike the partial update endpoint, this replaces the entire policy state with the provided payload, removing any breaks or assignments not included in the request.

OAuth Scopes: time_tracking:breaks.write

put/api/v1/time-tracking/break-policies/{id}/sync

Path parameters

idstring uuid required

The break policy ID.

Request body

namestring

Name of the break policy

descriptionstring nullable

Optional description of the break policy

allEmployeesAssignedboolean

Whether all employees are assigned to this break policy

employeeIdsinteger[]

The employees that should be assigned to this policy

Example request

{
  "name": "California",
  "description": "All breaks for California compliance",
  "allEmployeesAssigned": true,
  "breaks": [
    {
      "name": "Lunch Break",
      "duration": 60
    }
  ]
}

Response

Break policy synced successfully

idstring uuid

Unique identifier for the break policy

namestring

Name of the break policy

descriptionstring nullable

Optional description of the break policy

allEmployeesAssignedboolean

Whether all employees are assigned to this break policy

createdAtstring date-time

ISO 8601 timestamp when the break policy was created

updatedAtstring date-time nullable

ISO 8601 timestamp when the break policy was last updated

deletedAtstring date-time nullable

ISO 8601 timestamp when the break policy was deleted

employeeIdsinteger[]

The employees that are assigned to this policy

Example response

{
  "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",
  "breaks": [
    {
      "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"
    }
  ]
}