v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Meal & Rest Breaks

Public API

List Employee Break Availabilities

Retrieves break availability information for an employee. Requires permission to view the target employee in addition to time-tracking-break access.

OAuth Scopes: time_tracking:breaks

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

Path parameters

idinteger required

The internal employee ID.

Query parameters

effectivestring

The employee's local time that should be used to calculate availability. Defaults to the current time. Must be in Y-m-d\TH:i:s format (no timezone offset).

Response

Successfully retrieved break availabilities for the specified employee

idstring uuid

The unique identifier for the time tracking break

namestring

The name of the break

policyIdstring uuid

The unique identifier of the break policy this break belongs to

paidboolean

Whether the break is paid

durationinteger

Duration of the break in minutes

availabilityType'anytime' | 'hours_worked' | 'time_of_day'

When the break is available to be taken

calculatedAtstring date-time

When the break availability was calculated

effectiveAtstring date-time

Timestamp that all time-based calculations are evaluated relative to.

timezonestring

The timezone the break availability is calculated in

recordedDurationinteger

The duration of the break that has been recorded so far

availableboolean

Whether the break is currently available to be taken

availableAfterMinutesWorkedinteger nullable

Minutes of work after which the break becomes available

availableIninteger nullable

Minutes until the break becomes available

unavailableIninteger nullable

Minutes until the break becomes unavailable

availableAtstring date-time nullable

When the break is or becomes available

unavailableAtstring date-time nullable

When the break is or becomes unavailable

Example response

[
  {
    "id": "0199de9b-6bcb-77e7-941d-3caf74b9a372",
    "name": "Lunch Break",
    "duration": 60
  }
]