Skip to content

List workforce plans

GET/hr/workforce-plans

Returns all workforce plans. Each plan captures headcount assumptions and projections over a defined horizon in months. Use these plans for budgeting and scenario modelling during annual people-planning cycles.

Request

This endpoint takes no parameters and no request body.

Responses

200 List of workforce plans

Content type application/json, object.

FieldTypeRequiredDescription
dataarray of object · WorkforcePlanV1No
data[].idintegerNo

Auto-incremented primary key.

data[].namestringNo

Plan title (e.g. "FY2026 Headcount Plan").

Example: "FY2026 Headcount Plan"

data[].horizon_monthsintegerNo

Number of months the plan spans.

Example: 12

data[].assumptionsobject, nullableNo

Planning assumptions such as attrition rate and hiring budget.

data[].plan_payloadobject, nullableNo

Month-by-month headcount projections.

data[].statusstringNo

Lifecycle status of the plan.

One of: "draft", "active", "archived" · Example: "active"

data[].created_byinteger, nullableNo

Tenant user ID who created the plan.

data[].created_atstring (date-time)No

Record creation timestamp.

Example

{
  "data": [
    {
      "id": 1,
      "name": "FY2026 Headcount Plan",
      "horizon_months": 12,
      "status": "active",
      "assumptions": {
        "attrition_rate": 0.08,
        "hiring_budget": 120000
      },
      "plan_payload": {
        "months": [
          {
            "month": "2026-05",
            "hires": 3,
            "exits": 1
          }
        ]
      },
      "created_by": 1,
      "created_at": "2026-01-10T08:00:00Z"
    }
  ]
}

401 Unauthenticated

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/hr/workforce-plans" \
  -H "Accept: application/json"
Loading