FAfactorialhr
TimePlanning > PlannedBreak

Reads all Planned breaks

Changed on

Reads all Planned breaks

get/api/2026-10-01/resources/time_planning/planned_breaks

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/time_planning/planned_breaks
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: shift_management
    • or OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: time_tracking
    • or API key in header x-api-key

Query parameters

ids[]string[] required

List of planned break identifiers

paidboolean required

Filter by paid or unpaid breaks

default_shift_ids[]string[] required

List of default shift identifiers

shift_ids[]string[] required

List of shift identifiers

day_configuration_ids[]string[] required

List of day configuration identifiers

shift_configuration_ids[]string[] required

List of shift configuration identifiers

active_break_configurationboolean required

Filter by active break configurations only

Response

OK

Example response

{
  "data": [
    {
      "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"
    }
  ]
}

Changes