Sign in

v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Succession Plan

List Succession Plan Incumbents

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.

get/api/v2/careerhub/succession_plans/{positionId}/incumbents

Path parameters

positionIdinteger required

Eightfold position ID associated with the succession plan

Query parameters

startinteger

Specifies the offset value to start for the page

limitinteger

Specifies the number of entries to be returned for the page

querystring

Wildcard text used when searching for the results

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK