EIeightfold
Upskill Plan Assignment

Get Upskill Plan Assignment by External Id

Changed on

Fetch an assigned upskilling plan by the caller's externalId, scoped to the assignee.

get/api/v2/careerhub/{profileEncId}/upskill-plan-assignment/ext/{externalId}

Request

Path parameters

profileEncIdstring required

Encoded profile id: id from GET /api/v2/core/employees

externalIdstring required

The caller's own id for the plan, unique per profile

Query parameters

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

createdAtinteger nullable

Created timestamp (epoch seconds)

idinteger nullable

Assignment id (profile_data primary key)

planStatusstring nullable

invited | in_progress | completed | archived

externalIdstring nullable

Your external record id, unique per assignee. Addresses the plan in the /ext/<externalId> paths.

namestring nullable required

Plan display name

userIdstring nullable

Plan creator user id

completionPercentageinteger nullable

Completion percentage 0-100 (derived)

profileIdinteger nullable

Assignee profile id

startDateinteger nullable

Start date (epoch seconds)

lastProgressTsinteger nullable

Last progress timestamp (epoch seconds, system-set)

groupIdstring nullable

Tenant group id

updatedAtinteger nullable

Updated timestamp (epoch seconds)

lastNotifiedTsinteger nullable

Last notification timestamp (epoch seconds, system-set)

targetDateinteger nullable

Target completion date (epoch seconds)

parentPlanIdinteger nullable

Template plan id this assignment was cloned from

Changes