Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
TimePlanning > PlannedBreak

Reads a single Planned break

Reads a single Planned break

get/api/2026-07-01/resources/time_planning/planned_breaks/{id}

Path parameters

idstring required

List of planned break identifiers

Response

OK

idstring required

Planned break identifier

start_atstring

Break start time

end_atstring

Break end time

durationinteger

Duration of the break in minutes

break_type'flexible' | 'fixed' | 'semi_flexible' required

Type of the break

break_configuration_idstring required

Break configuration identifier

break_configuration_namestring required

Name of the break configuration

break_configuration_paidboolean required

Whether the break is paid

default_shift_idstring

Default shift identifier

shift_configuration_idstring

Shift configuration identifier

shift_idstring

Shift identifier

day_configuration_idstring

Day configuration identifier

Example response

{
  "id": "1",
  "start_at": "2020-09-07T06:00:00.000+00:00",
  "end_at": "2020-09-07T15:00:00.000+00:00",
  "duration": 30,
  "break_type": "flexible",
  "break_configuration_id": "1",
  "break_configuration_name": "Rest",
  "break_configuration_paid": true,
  "shift_id": "1"
}