v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Meal & Rest Breaks

Public API

List Employee Break Policies

Retrieves break policies assigned to a specific employee. Requires permission to view the target employee.

OAuth Scopes: time_tracking:breaks

get/api/v1/time-tracking/employees/{id}/break-policies

Path parameters

idinteger required

The internal employee ID.

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set. Minimum 0. Defaults to 0.

limitinteger

The maximum number of items to return. Must be between 0 and 500. Defaults to 100.

Response

A list of 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"
    }
  ]
}