---
title: "List Succession Plan Incumbents"
method: GET
path: "/api/v2/careerhub/succession_plans/{positionId}/incumbents"
tags: ["Succession Plan"]
---

# List Succession Plan Incumbents

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

## Request

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

Get a list of incumbents of the succession plan. The plan is specified by the position ID in the request path. This endpoint is mainly to support getting incumbents for role-based succession plans which cannot show the incumbents in the Succession Plan Get and List endpoints.

## Path parameters

- `positionId` integer, required

## Query parameters

- `start` integer
- `limit` integer
- `query` string
- `exclude` string
- `keyList` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `data` SuccessionPlanIncumbentSchema[]
    - `externalJobId` string, nullable: Position ID associated with the incumbent in ATS/HRIS
    - `employeeId` string, nullable: ATS/HRIS employee ID of the incumbent
    - `profileId` integer, nullable: Eightfold decoded profile ID (numeric) of the incumbent
  - `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)
