---
title: "Reads all Planned breaks"
method: GET
path: "/api/2026-10-01/resources/time_planning/planned_breaks"
tags: ["TimePlanning > PlannedBreak"]
---

# 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: one of:
  - OAuth 2
    - Authorization code: `https://id.factorialhr.com/oauth/authorize`
    - Token URL: `https://id.factorialhr.com/api/oauth/token` scopes: `shift_management`
  - OAuth 2
    - Authorization code: `https://id.factorialhr.com/oauth/authorize`
    - Token URL: `https://id.factorialhr.com/api/oauth/token` scopes: `time_tracking`
  - API key in header `x-api-key`

Reads all Planned breaks

## Query parameters

- `ids[]` string[], required: List of planned break identifiers
- `paid` boolean, 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_configuration` boolean, required: Filter by active break configurations only

## Response `200`

OK

- object
  - `data` TimePlanningPlannedBreak[]
    - `id` string, required: Planned break identifier
    - `start_at` string: Break start time
    - `end_at` string: Break end time
    - `duration` integer: Duration of the break in minutes
    - `break_type` 'flexible' | 'fixed' | 'semi_flexible', required: Type of the break
    - `break_configuration_id` string, required: Break configuration identifier
    - `break_configuration_name` string, required: Name of the break configuration
    - `break_configuration_paid` boolean, required: Whether the break is paid
    - `default_shift_id` string: Default shift identifier
    - `shift_configuration_id` string: Shift configuration identifier
    - `shift_id` string: Shift identifier
    - `day_configuration_id` string: Day configuration identifier
  - `meta` PagedIndexMeta
    - `start_cursor` string
    - `end_cursor` string
    - `has_previous_page` boolean, required
    - `has_next_page` boolean, required
    - `limit` integer, required
    - `total` integer, required

## Changes

- **2026-11-03** `83ac9aa1de50`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/factorialhr/apis/factorial-api/changes/api/2026-10-01/resources/time_planning/planned_breaks/get.md)

---

[API](https://skmtc.dev/factorialhr/apis/factorial-api.md) - [All operations](https://skmtc.dev/factorialhr/apis/factorial-api/llms.txt) - [OpenAPI document](https://skmtc.dev/factorialhr/apis/factorial-api/revisions/83ac9aa1de50?raw)