Skip to content

List succession pools

GET/hr/succession-pools

Returns all succession pools. Each pool identifies candidate employees being groomed for a specific position, along with their readiness scores. Use this to support leadership continuity planning and talent reviews.

Request

This endpoint takes no parameters and no request body.

Responses

200 List of succession pools

Content type application/json, object.

FieldTypeRequiredDescription
dataarray of object · SuccessionPoolV1No
data[].idintegerNo

Auto-incremented primary key.

data[].namestringNo

Pool name (e.g. "CTO Pipeline").

Example: "CTO Pipeline"

data[].position_idinteger, nullableNo

Target position ID from hr_positions.

data[].candidate_idsarray of integerNo

Employee IDs in the pool.

data[].readiness_scoresmap of string, nullableNo

Map of employee ID (string key) to readiness label (ready_now / ready_1yr / ready_2yr).

data[].statusstringNo

Pool lifecycle status.

One of: "active", "inactive" · Example: "active"

data[].created_byinteger, nullableNo

Tenant user ID who created this pool.

data[].created_atstring (date-time)No

Record creation timestamp.

Example

{
  "data": [
    {
      "id": 2,
      "name": "CTO Pipeline",
      "position_id": 5,
      "candidate_ids": [
        8,
        14,
        22
      ],
      "readiness_scores": {
        "8": "ready_now",
        "14": "ready_1yr",
        "22": "ready_2yr"
      },
      "status": "active",
      "created_by": 1,
      "created_at": "2026-02-01T09:00:00Z"
    }
  ]
}

401 Unauthenticated

Example request

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