List compensation bands
GET/hr/compensation-bands
Returns all compensation bands ordered newest-first, together with succession pools and workforce plans. Use this to review the full salary-range structure and inspect the computed budget-delta across all bands before making changes.
Request
This endpoint takes no parameters and no request body.
Responses
200 Compensation bands with summary statistics
Content type application/json, object.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object · CompensationBandPlanV1 | No | |
data[].id | integer | No | Auto-incremented primary key. |
data[].name | string | No | Display name for the band (e.g. "Senior Engineer"). Example: |
data[].min_amount | number | No | Lower bound of the salary range. Example: |
data[].max_amount | number | No | Upper bound of the salary range. Example: |
data[].currency | string | No | ISO 4217 currency code. Example: |
data[].scope | object, nullable | No | Optional applicability filter. May contain 'departments' or 'positions' arrays to restrict which org units this band applies to. |
data[].status | string | No | Whether the band is currently in use. One of: |
data[].created_by | integer, nullable | No | Tenant user ID who created this record. |
data[].created_at | string (date-time) | No | Record creation timestamp. |
summary | object · HrPlanningSummaryV1 | No | Aggregate planning metrics for the HR planning dashboard. |
summary.bands | integer | No | Total number of compensation bands. |
summary.active_pools | integer | No | Number of succession pools with 'active' status. |
summary.active_plans | integer | No | Number of workforce plans with 'active' status. |
summary.budget_delta | number | No | Sum of (max_amount - min_amount) across all bands in the primary currency. |
summary.currency | string | No | Currency of the budget_delta figure. Example: |
Example
{
"data": [
{
"id": 4,
"name": "Senior Engineer",
"currency": "GHS",
"min_amount": 8000,
"max_amount": 14000,
"scope": {
"departments": [
"Engineering"
]
},
"status": "active",
"created_by": 1,
"created_at": "2026-01-15T10:00:00Z"
}
],
"summary": {
"bands": 4,
"active_pools": 2,
"active_plans": 1,
"budget_delta": 24000,
"currency": "GHS"
}
}401 Unauthenticated
Example request
curl -X GET "https://{tenant}.faciotech.net/api/v1/hr/compensation-bands" \
-H "Accept: application/json"