FAfactorialhr
Timeoff > BlockedPeriod

Reads a single Blocked period

Changed on

Retrieves blocked periods

get/api/2026-10-01/resources/timeoff/blocked_periods/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/timeoff/blocked_periods/{id}
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: time_off
    • or API key in header x-api-key

Path parameters

idstring required

Response

OK

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

Changes