Retrieve the consolidated workforce compliance overview

Return the consolidated time-tracking compliance panel for your whole managed portfolio: one row per active managed company, each projected from that company's latest monthly close without recomputation — whether the current (last closable) period is closed, its status (closed/reopened), the last closed period (last_closed_year/last_closed_month), and the aggregated total_balance_minutes, total_overtime_minutes and employee_count.

Master-scoped: the portfolio is resolved from your API key, never from the payload, and only your own children appear.
Unlike the per-company X-Active-Profile endpoints, this aggregates across children in a single call.
Returned as { "data": [ConsolidatedWorkforce, ...] }.

Authorization

AuthorizationBearer <token>

In: header

Headers

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Response Body

`application/json`

Request example

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/gestoria/workforce-summary", {  method: "GET",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json"} },});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Response example

{
  "data": [
    {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a02",
      "name": "Distribuciones Ibéricas, S.L.",
      "tax_id": "B87654323",
      "current_period_closed": true,
      "current_period_status": "closed",
      "last_closed_year": 2026,
      "last_closed_month": 4,
      "total_balance_minutes": 1200,
      "total_overtime_minutes": 540,
      "employee_count": 12
    }
  ]
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_3f0e9c39de63ffc00b29fb8358"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'companies:read'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_2265fb88add1d720981e0ccdd8"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_1ae3c2462330b9adaa19a3e1c6"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_c0e94736162210309d7bc31fa6"
  }
}

Retrieve the consolidated workforce compliance overview

Authorization

Headers

Response Body

200application/json

401application/json

403application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`