v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Meal & Rest Breaks
Public API

List Break Policy Employees

Retrieves employees assigned to a specific break policy. If a policy has no assignments, returns HTTP 200 with an empty data array.

OAuth Scopes: time_tracking:breaks

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

Path parameters

idstring uuid required

The break policy ID.

Query parameters

offsetinteger

The offset of items to retrieve

limitinteger

The maximum items to retrieve

Response

A list of employees assigned to a break policy

Example response

{
  "meta": {
    "totalItems": 3,
    "offset": 2,
    "limit": 2
  }
}