FAfactorialhr
Timeoff > BlockedPeriod

Reads all Blocked periods

Changed on

Retrieves blocked periods

get/api/2026-10-01/resources/timeoff/blocked_periods

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/timeoff/blocked_periods
  • 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

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

Changes