GuidesAPI ReferenceChangelog
API Reference
These docs are for v2025-10-01. Click to read the latest docs for v2026-04-01.

Reads all Planned breaks

get
https://api.factorialhr.com/api/2025-10-01/resources/time_planning/planned_breaks

Reads all Planned breaks

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids[]
array of integers
required

List of planned break identifiers

ids[]*
boolean
required

Whether to include only paid breaks or unpaid breaks

default_shift_ids[]
array of integers
required

List of default shift identifiers

default_shift_ids[]*
shift_ids[]
array of integers
required

List of shift identifiers

shift_ids[]*
day_configuration_ids[]
array of integers
required

List of day configuration identifiers

day_configuration_ids[]*
shift_configuration_ids[]
array of integers
required

List of shift configuration identifiers

shift_configuration_ids[]*
boolean
required

Whether to include only active break configurations

Response

Updated 7 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago