List Succession Plans

Specifies the offset value to start for the page

Specifies the number of entries to be returned for the page

This specifies list of incumbent profile IDs. If this is given, only plans that have incumbents who match the specified profile IDs are returned. The format should be comma-separated values with or without spaces (ex. 1000,2000, 3000).

This specifies a list of successor profile IDs. If this is given, only plans where any of the specified profiles is an active successor are returned. Each ID may be numeric or encoded. For user-token (JWT) callers, the request fails with a 403 if the caller does not have manager or HRBP access to every specified profile, and the returned plans are limited to those the caller is allowed to view; totalCount then reflects the number of plans returned on the current page after view-access filtering, not a global count to paginate against. The format should be comma-separated values with or without spaces (ex. 1000,2000, 3000).

Wildcard text used when searching for the results

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.

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