v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Meal & Rest Breaks

Public API

Get Break Policy

Retrieves a single break policy by its UUID. When includeCounts is enabled, the response includes the number of associated employees and breaks.

OAuth Scopes: time_tracking:breaks

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

Path parameters

idstring uuid required

The break policy ID.

Query parameters

includeCountsboolean

Include employee and break counts

Response

Break policy retrieved 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

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"
}