v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB

Profile

Get Profile

Given a profile id of a candidate, it returns all attributes of the profile

get/api/v2/core/profiles/{profileId}

Path parameters

profileIdstring required

ID of candidate in Eightfold

Query parameters

includestring

Include additional fields in the response. Possible values are resume, applications, tags, notes, attachmentsInfo, inferredSkills, careerSiteQuestions, deletedAt, demandExperiences, jtnSubmissions, lastContact

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

jtnSubmissionsobject nullable

Join talent network submissions

atsEntityIdstring nullable

Ats Entity Id of candidate

profileIdinteger

Raw ID of the profile

seniorityLevelstring nullable

Seniority level of candidate

locationstring nullable

Location associated with the candidate

firstNamestring required

First Name of candidate

emailstring nullable

Emails of the candidate comma seperated format

lastUpdatedinteger

Last updated time stamp of profile

imageUrlstring nullable

Image Url of candidate

roleIdstring nullable

role id associated with the profile

workExperienceYearsnumber float nullable

Total work experience in years (float)

resumeFileNamestring nullable

Latest resume file name

efRacestring nullable

Race inferred by Eightfold

fullNamestring nullable

Full name of candidate

resumestring nullable

base 64 encoded string representing resume of the candidate

customInfoobject nullable

Custom information for Eightfold Profile (not same as product custom information)

isConfidentialboolean nullable

Flag indicating whether the candidate profile is confidential. Setting this to true will add the Confidential tag to the profile.

isCurrentEmployeeboolean nullable

True if this profile is a current employee of the tenant

urlsstring[] nullable

urls for candidate's online profiles

phonestring nullable

Phone of candidate

titlestring nullable

Work title of candidate

idstring nullable

Encoded Id of candidate

deletedAtinteger nullable

Deleted at time stamp of the profile

racestring nullable

race value fetched from ATS data if available otherwise inferred if inference is enabled

additionalSectionsobject nullable

Additional section defined by the customer

currentCompanystring nullable

Current employer of the candidate

socialMediaLinksstring[] nullable

Social-media profile URLs (filtered subset of urls)

languagestring nullable

Predicted language of the candidate

educationLevelstring nullable required

Education Level

efCustomInfoobject nullable

Custom information for Eightfold Profile. This will be the same information as product custom information

dupeDataobject nullable

Information related to duplicate profile ids

highlightsstring[] nullable

list of highlights for the profile

summarystring nullable

Summary of candidate

customFieldsobject nullable

ats custom fields key-value pairs, key is the field name

genderstring nullable

Gender of candidate

industriesstring[] nullable

Industries in which candidate has worked

efGenderstring nullable

Gender inferred by Eightfold

lastNamestring nullable

Last Name of candidate