GuidesAPI ReferenceChangelog
API Reference

Reads all Planned breaks

get
https://api.factorialhr.com/api/2026-04-01/resources/time_planning/planned_breaks

Reads all Planned breaks

Query Params
ids[]
array of integers
required

List of planned break identifiers

ids[]*
boolean
required

Filter by paid 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

Filter by active break configurations only

Response

Updated 3 months ago

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