Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Timeoff > BlockedPeriod

Creates a Blocked period

Creates a blocked period is add a range of dates during which employees cannot submit time off requests. This allows to better plan your team's work throughout the year and ensure that time off requests are in line with the company's needs

post/api/2026-07-01/resources/timeoff/blocked_periods

Request body

company_idstring required

The company id

namestring required

Name of the blocked period.

leave_type_idsstring[] required

An array of leave type identifiers for which employees can not request timeoff

Example request

{
  "company_id": "1",
  "name": "Onboarding period",
  "leave_type_ids": [
    "1",
    "2",
    "4"
  ]
}

Response

CREATED

idstring required

Unique identifier of the blocked period

company_idstring required

Company id of the blocked period

namestring required

Name of the blocked period.

leave_type_idsstring[] required

Leave types for which absence request has been blocked

strategystring required

Type of access group

membersstring[] required

Employees whose timeoff will be affected

location_idsstring[]

List of locations workplace identifiers where the employees are located

team_idsstring[]

List of team identifiers which the selected employees belong to

legal_entity_idsstring[]

List of legal entity identifiers which the selected employees belong to

Example response

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