---
title: "Get Recommended Successors"
method: GET
path: "/api/v2/careerhub/succession_plans/{positionId}/recommended_successors"
tags: ["Succession Plan"]
---

# Get Recommended Successors

`GET /api/v2/careerhub/succession_plans/{positionId}/recommended_successors`

## Request

- Base URL: `https://apiv2.eightfold.ai`
- URL: `https://apiv2.eightfold.ai/api/v2/careerhub/succession_plans/{positionId}/recommended_successors`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/eightfold/apis/api-server-v2-service-service/docs/api/v2/careerhub/succession_plans/:positionId/recommended_successors/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a list of recommended successors for the specified succession plan given a position ID. The endpoint does not support pagination due to a post-processing step where employee profiles are sorted by the match score. Because of that the results will always return a full list with max number of results as 100. A sample request looks like this, https://apiv2.eightfold.ai/api/v2/careerhub/succession_plans/1234567/recommended_successors, where 1234567 is the position ID of the plan.

## Path parameters

- `positionId` integer, required

## Query parameters

- `exclude` string
- `keyList` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `data` RecommendedSuccessorSchema[]
    - `name` string, nullable: Full name of the employee
    - `profileId` integer, nullable: Eightfold decoded profile ID (numeric)
    - `matchScores` EmployeeMatchScoreSchema[], nullable: Match score details
      - `matchType` string, nullable: Match score criteria
      - `rawScore` number, float, nullable: Raw match score in float
      - `topMatches` string[], nullable: Top items matched based on the match type
      - `score` integer, nullable: Rounded match score in integer
    - `email` string, nullable: Email of the employee
    - `title` string, nullable: Title of the employee
  - `meta` MetaSchema
    - `totalCount` integer, nullable
    - `pageTotalCount` integer, nullable
    - `pageStartIndex` integer, nullable

---

[API](https://skmtc.dev/eightfold/apis/api-server-v2-service-service.md) - [All operations](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/llms.txt) - [OpenAPI document](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/revisions/9a8b3a927e93?raw)