Get Recommended Successors
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.
Request
- Base URLhttps://apiv2.eightfold.ai
- Authnone declared. Required headers: Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Eightfold position ID associated with the succession plan
Query parameters
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.
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
The secret key to access the api. It starts with the bearer token
Response
OK
Changes
No recorded changes to this operation across all 2 revisions of this API.