FAfactorialhr
TimePlanning > PlanningVersion

Reads all Planning versions

Changed on

Reads all Planning versions

get/api/2026-10-01/resources/time_planning/planning_versions

Request

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

Query parameters

employee_ids[]string[]

List of employee identifiers

[
  "1",
  "2",
  "3"
]
for_shiftsboolean

Filter by shift management planning tool

Example:true
only_activeboolean required

Filter by active planning versions only

planning_tool'shift_management' | 'work_schedule' | 'contract_hours'

Type of planning tool (shift_management, work_schedule, contract_hours)

Example:shift_management
schedule_ids[]string[]

List of work schedule identifiers to include

[
  "1",
  "2",
  "3"
]

Response

OK

Example response

{
  "data": [
    {
      "id": "1",
      "effective_at": "2020-09-07",
      "planning_tool": "shift_management",
      "number_of_rest_days_in_cents": 200,
      "employee_id": "1",
      "work_schedule_schedule_id": "1"
    }
  ]
}

Changes