Sign in

v1

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

Create Break

Creates a new break and associates it with the specified break policy.

OAuth Scopes: time_tracking:breaks.write

post/api/v1/time-tracking/break-policies/{id}/breaks

Path parameters

idstring uuid required

The break policy ID.

Request body

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

availabilityMinHoursWorkednumber float nullable

Minimum hours that must be worked before the break can be taken

availabilityMaxHoursWorkednumber float nullable

Maximum hours that can be worked before the break must be taken

availabilityStartTimestring time nullable

Earliest time the break can be taken (HH:MM format)

availabilityEndTimestring time nullable

Latest time the break can be taken (HH:MM format)

Example request

{
  "name": "Lunch Break",
  "duration": 60
}

Response

Successfully created a break

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

availabilityMinHoursWorkednumber float nullable

Minimum hours that must be worked before the break can be taken

availabilityMaxHoursWorkednumber float nullable

Maximum hours that can be worked before the break must be taken

availabilityStartTimestring time nullable

Earliest time the break can be taken (HH:MM format)

availabilityEndTimestring time nullable

Latest time the break can be taken (HH:MM format)

createdAtstring date-time

ISO 8601 timestamp when the break was created

updatedAtstring date-time nullable

ISO 8601 timestamp when the break was last updated

deletedAtstring date-time nullable

ISO 8601 timestamp when the break was deleted

Example response

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