v1
latestOpenAPI 3.1.02026-07-26549156879.0 KBTimeoff > BlockedPeriod
Reads all Blocked periods
Retrieves blocked periods
get/api/2026-07-01/resources/timeoff/blocked_periods
Query parameters
ids[]string[]
company_ids[]string[]
Response
OK
Example response
{
"data": [
{
"id": "1",
"company_id": "1",
"name": "Onboarding period",
"leave_type_ids": [
"1",
"2"
],
"time_periods": [
{
"name": "Product offsite",
"period_type": "by_contract_start_date",
"duration": 2,
"duration_unit": "months",
"start_on": "2024-01-01",
"finish_on": "2024-02-28"
}
],
"strategy": "everyone",
"members": [
"1",
"2"
],
"location_ids": [
"1",
"2"
],
"team_ids": [
"1",
"2"
],
"legal_entity_ids": [
"1",
"2"
]
}
]
}