List Matched Positions for Employee
Changed onReturns the positions recommended to an employee, at parity with the Career Hub 'Recommended jobs' feed: the tenant's Career Hub position visibility rules, feed search overrides, the employee's job preferences and location, and dismissed jobs all apply, and results are sorted by match score. The tenant must show a Recommended Jobs feed on the employee Career Hub home page (a recommended_jobs feed, or a feed with template_type recommended_jobs, listed in order_of_feeds and defined in feeds); otherwise the call returns 400. An empty list means the feed has no recommendations for the employee. By default the Career Hub fallback rows ("Showing other relevant jobs") are not returned; pass fallback=true to get them when the primary feed is empty and the tenant's feed config enables a fallback. Runs as the employee, so the employee must have a user login and Career Hub enabled. For the recruiter-side ATS match of any profile use /profiles/<profileId>/matched-positions instead. JWT callers need Career Hub position access and can only request their own recommendations.
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 employee profile ID (encoded or decoded), or the employee ID from the HR system. The profile ID is tried first.
Query parameters
Specifies the offset value to start for the page
Specifies the number of entries to be returned for the page
Defaults to true. Pass false to skip computing validatedSkills and missingSkills, returning them as empty lists.
Defaults to false. Pass true to return the Career Hub fallback rows (the tenant feed config's fallback_config, shown on the home page as 'Showing other relevant jobs') when the primary recommended-jobs feed is empty and the tenant config has should_call_fallback enabled. Fallback rows are not personalised matches.
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
- info
endpoint added
- info