--- title: "List Profiles" method: GET path: "/api/v2/core/profiles" tags: ["Profile"] --- # List Profiles `GET /api/v2/core/profiles` Search profiles using query parameters and get the complete profile objects ## Query parameters - `start` integer - `limit` integer - `atsCandidateId` string - `profileIds` string - `filterQuery` string - `query` string - `include` string - `exclude` string - `keyList` string ## Headers - `Authorization` string, required ## Response `200` OK - object - `data` ExternalProfileSchema[] - `preferences` Preferences - `contactConsent` string, nullable — Candidate consent - `jtnSubmissions` object, nullable — Join talent network submissions - `internalGroupAffiliation` InternalGroupAffiliation[], nullable — Group memberships and affiliations to internal groups - `endTs` integer, nullable — Membership/Position end timestamp in seconds - `startTs` integer, nullable — Membership/Position start timestamp in seconds - `positionType` string, nullable — Type of the membership/position - `internalGroup` string, nullable — Internal group of the membership/position - `isCurrent` boolean, nullable — Whether profile is currently affiliated to this Membership/Position - `description` string, nullable — Description of the membership/position - `title` string, nullable — Title of the membership/position - `atsEntityId` string, nullable — Ats Entity Id of candidate - `endorsements` Endorsement[], nullable — endorsements of candidate - `work` string, nullable — Endorsements work - `description` string, nullable — Endorsements description - `metadata` string, nullable — Endorsements metadata - `profileId` integer — Raw ID of the profile - `seniorityLevel` string, nullable — Seniority level of candidate - `skills` ProfileSkill[], nullable — List of profile skills - `displayName` string, nullable — Display name of the skill - `evaluations` ProfileSkillEvaluation[], nullable — Latest assessments of the skill as provided by the employee/candidate or the employee's manager - `skillSubGroup` string, nullable — The sub group within the skill group assigned to the skill. This is available only if the skill taxonomy is setup - `level` number, float, nullable — Normalized proficiency level on the scale of 0-1 - `proficiency` string, nullable — The display value of the assessed proficiency for the skill - `skillGroup` string, nullable — The skill group assigned to the skill. This is availalble only if skill taxonomy is setup - `skillGroupDescription` string, nullable — Description of the skill group. This is available only if skill taxonomy is setup - `source` string, nullable — Indicates who made the assessment for the skill - self/manager - `skillCategoryDescription` string, nullable — Description of the skill category. This is available only if skill taxonomy is setup - `assessmentProvider` string, nullable — Name of the assessment provider/vendor if assessments are made in a 3rd party tool and ingested into Eightfold - `skillCategory` string, nullable — The category of the skill group. This is available only if skill taxonomy is setup - `source` Source1 - `entityId` string, nullable — The id of the entity that is attributed for gaining this skill in the external system (eg: course id for a completed course) - `name` string, nullable — The external system that added this skill to the profile - `name` string, nullable — Normalized skill name - `location` string, nullable — Location associated with the candidate - `careerSiteQuestions` CareerSiteQuestionsSchema[], nullable — Questions and answers from career site applications - `timestamp` integer, nullable — Timestamp when questions were answered - `positionIdList` string[], nullable — List of position ids questions are answers for - `mode` string, nullable — Mode of the questions - `questions` object, nullable — Question and Answers details - `firstName` string, required — First Name of candidate - `address` ProfileAddressSchema - `zip` string, nullable — Postal code - `country` string, nullable — Country - `city` string, nullable — City - `street` string, nullable — Street / house number - `state` string, nullable — State / region - `lastContact` ProfileLastContactSchema - `senderEmail` string, nullable — Email of the user who last contacted the candidate - `senderUserId` string, nullable — EF user id of the user who initiated the last contact - `lastContactTs` integer, nullable — Unix epoch timestamp of the last contact event - `resumeContent` AtsContent - `extension` string, nullable — extension - `content` string, nullable — content - `isBase64` boolean, nullable — is base 64 encoded? - `employeeInfo` EmployeeInfo - `successionPlan` ProfileSuccessionPlan - `successionPlanRole` string, nullable — succession plan Role - `successionPlanNotes` ProfileSuccessionPlanNote[], nullable — succession plan notes - `managerName` string, nullable — name of the manager - `status` string, nullable — status of the note - `noteType` string, nullable — Type of note. Eg:- general assessment - `managerProfileId` string, nullable — encoded profile id of the manager - `noteId` string, nullable — noteId of the note - `content` string, nullable — content of the note - `successors` ProfileSuccessors[], nullable — The successors of the profile - `successorProfileId` string, nullable — profile id of the successor - `successorReadiness` string, nullable — readiness state of the successor - `leaderWithoutPathForward` string, nullable — leader without path forward(succession count) - `successionPlanId` string, nullable — succession plan ID - `successionPlanMetrics` ProfileSuccessionPlanMetric - `readiness` object, nullable — readiness of succession plan - `employeeId` string, nullable — Employee Id of the profile - `relocationPreferences` ProfileRelocation - `comments` string, nullable — comments - `travelPercentageMin` number, float, nullable — Minimum Travel percentage for profile - `relocationLocations` string[], nullable — list of relocation preferences of the profile - `externalKey` string, nullable — external Key - `relocation` string, nullable — relocation needed Yes/No - `travel` string, nullable — travel - `travelPercentageMax` number, float, nullable — Maximum Travel percentage for profile - `performanceManagement` ProfilePerformanceManagement - `promotionReadiness` ProfilePromotionReadiness - `managerProfileId` string, nullable — Profile Id of the manager - `readiness` string, nullable — Readiness for Promotion - `performanceRatings` ProfilePerformanceRating[], nullable — Performance ratings of the profile - `rating` number, float, nullable — The rating given - `reviewedBy` ProfileReviewer - `email` string, nullable — Email of the user who reviewed the profile - `profileId` string, nullable — Profile Id of the user who reviewed the profile - `performancePeriodEndDate` string, nullable — The performance period end date - `ratingLabel` string, nullable — The rating label - `reviewComments` string[], nullable — The review comments - `reviewType` string, nullable — The review type - `performancePeriodStartDate` string, nullable — The performance period start date - `email` string, nullable — Emails of the candidate comma seperated format - `lastUpdated` integer — Last updated time stamp of profile - `imageUrl` string, nullable — Image Url of candidate - `roleId` string, nullable — role id associated with the profile - `workExperienceYears` number, float, nullable — Total work experience in years (float) - `resumeFileName` string, nullable — Latest resume file name - `awards` Award[], nullable — Awards of candidate - `entity` string, nullable — award entity - `date` string, required — date for award - `allText` string, nullable — all text data for award - `skills` string[], nullable — Award skills - `description` string, nullable — description for award - `title` string, required — award title - `education` CandidateEducation[], nullable — Education of candidate - `verificationStatus` string, nullable — verification status of the education details - `location` string, nullable, required — Location of Candidate Education - `school` string, nullable, required — School of candidate - `isCurrent` boolean, nullable — Currently working in an organization - `isGraduated` boolean, nullable — graduation status of the candidate - `endTime` integer, nullable, required — end time of candidate - `awards` string[], nullable — Awards of candidate - `source` string, nullable — source - `degree` string, nullable, required — Degree of candidate - `startTime` integer, nullable, required — start time of candidate - `verificationBy` string, nullable — email of the verifier - `major` string, nullable, required — major of candidate - `majorExternalId` string, nullable — external id of the major - `verificationTs` integer, nullable — verification timestamp - `degreeExternalId` string, nullable — external id of the degree - `attachmentIds` string[], nullable — List of attachment ids of the education - `schoolExternalId` string, nullable — external id of the school - `nameAlias` string, nullable — name of the candidate in the records if different from the name in the profile - `description` string, nullable, required — Description of candidate - `efRace` string, nullable — Race inferred by Eightfold - `fullName` string, nullable — Full name of candidate - `resume` string, nullable — base 64 encoded string representing resume of the candidate - `profileStagedSections` ProfileStagedSections - `education` object, nullable — Education of candidate - `awards` object, nullable — Awards of candidate - `certificates` object, nullable — Certificates - `publications` object, nullable — publications of candidate - `languageProficiencies` object, nullable — language proficiences for employee - `endorsements` object, nullable — endorsements of candidate - `experiences` object, nullable — List of candidate's past experiences - `courses` object, nullable — course attendance of employee - `skills` object, nullable — List of candidate's skills - `patents` object, nullable — patents of candidate - `projects` object, nullable — projects of candidate - `skillGoals` ProfileSkillGoal[], nullable — List of profile skill goals - `goalType` string, nullable — goal type of the skill - `skill` string, nullable — name of the skill - `customInfo` object, nullable — Custom information for Eightfold Profile (not same as product custom information) - `experiences` ExperienceSchema[], nullable — List of candidate's past experiences - `industry` string, nullable — industry of the candidate/organization - `endTime` integer, nullable, required — End time of employee in an organization - `durationMonths` integer, nullable — Duration of work experience in months - `isInternal` boolean, nullable, required — is internal for candidate - `addlJson` object, nullable — Additional json data - `department` string, nullable — Department of the candidate - `work` string, nullable, required — Organization or Company of work - `userVerifiedSkills` boolean, nullable — any verified skills - `experienceKey` string, nullable — Unique key for each experience - `skills` string[] — Skills invovled - `location` string, nullable, required — Location of the organization - `startTime` integer, nullable, required — Start time of employee in an organization - `edited` boolean, nullable, required — is edited candidate? - `isCurrent` boolean, nullable, required — Currently working in an organization - `description` string, nullable, required — Description of work - `title` string, nullable, required — Title of work experience - `isConfidential` boolean, nullable — Flag indicating whether the candidate profile is confidential. Setting this to true will add the Confidential tag to the profile. - `isCurrentEmployee` boolean, nullable — True if this profile is a current employee of the tenant - `urls` string[], nullable — urls for candidate's online profiles - `demandExperiences` ExperienceSchema[], nullable — List of candidate's past demand experiences - `industry` string, nullable — industry of the candidate/organization - `endTime` integer, nullable, required — End time of employee in an organization - `durationMonths` integer, nullable — Duration of work experience in months - `isInternal` boolean, nullable, required — is internal for candidate - `addlJson` object, nullable — Additional json data - `department` string, nullable — Department of the candidate - `work` string, nullable, required — Organization or Company of work - `userVerifiedSkills` boolean, nullable — any verified skills - `experienceKey` string, nullable — Unique key for each experience - `skills` string[] — Skills invovled - `location` string, nullable, required — Location of the organization - `startTime` integer, nullable, required — Start time of employee in an organization - `edited` boolean, nullable, required — is edited candidate? - `isCurrent` boolean, nullable, required — Currently working in an organization - `description` string, nullable, required — Description of work - `title` string, nullable, required — Title of work experience - `phone` string, nullable — Phone of candidate - `title` string, nullable — Work title of candidate - `tags` Tag[], nullable — Tags of profile - `creatorEmail` string, nullable — creator email of candidate Tag - `id` string, required — Tag id of candidate - `tag` string, nullable — candidate Tag - `tagSubtype` string, nullable — Tag subtype - `profileId` string, nullable — candidate profile Id - `tagType` string, nullable — Type of candidate Tag - `url` string, nullable — url - `groupId` string, nullable — group id - `positionId` string, nullable — position id - `createdTime` integer, nullable, required — Created time of candidate Tag - `id` string, nullable — Encoded Id of candidate - `deletedAt` integer, nullable — Deleted at time stamp of the profile - `race` string, nullable — race value fetched from ATS data if available otherwise inferred if inference is enabled - `jtnAnswers` JTNAnswersSchema[], nullable — Join talent network answers - `label` string, nullable — Label of the question - `questionId` string, nullable — Question Id of the question - `type` string, nullable — Type of the question - `values` string, nullable — List of answers to the question - `additionalSections` object, nullable — Additional section defined by the customer - `sources` SourceSchema[] — Sourcing data of candidate - `sourceType` string, nullable - `datetime` string, date-time, nullable - `sourceName` string, nullable - `currentCompany` string, nullable — Current employer of the candidate - `socialMediaLinks` string[], nullable — Social-media profile URLs (filtered subset of `urls`) - `language` string, nullable — Predicted language of the candidate - `educationLevel` string, nullable, required — Education Level - `patents` Patent[], nullable — patents of candidate - `date` string, required — Patent date - `allText` string, nullable — Patent title - `skills` string[], nullable — Patent skills - `description` string, nullable — Patent description - `title` string, required — Patent title - `efCustomInfo` object, nullable — Custom information for Eightfold Profile. This will be the same information as product custom information - `dupeData` object, nullable — Information related to duplicate profile ids - `highlights` string[], nullable — list of highlights for the profile - `summary` string, nullable — Summary of candidate - `projects` Project[], nullable — projects of candidate - `addlJson` object, nullable — Additional Json Data - `projectId` string, required — Project projectid - `duration` integer, required — Project duration in months - `links` string[], nullable — Project links - `personal_description` string, nullable — Project personal description - `skills` string[], required — Project skills - `time` string, required — Project time - `feedback` ProjectFeedback[], nullable — Project feedback - `imageUrl` string, nullable, required — Image url - `rating` string, nullable, required — Rating - `name` string, nullable, required — Name - `projectId` integer, nullable, required — Project Id - `timestamp` integer, nullable, required — Feedback Timestamp in epoch seconds - `profileId` integer, nullable, required — Profile Id - `comment` string, nullable, required — Feedback Comment - `company` string, nullable, required — Project company - `contributors` string[], nullable, required — Project contributors - `description` string, nullable — Project description - `title` string, required — Project title - `applications` ProfileApplicationSchema[], nullable — Application of candidate - `stage` string, nullable - `lastModifiedTime` integer, nullable, required — Last Modified time stamp of candidate application - `applicationAnswers` ApplicationQuestionAnswers[], nullable — application answers of candidate application - `answer` string, nullable — Answer of candidate Application question answers - `questionId` string, nullable, required — question ID of candidate Application question answers - `question` string, nullable, required — question of candidate Application question answers - `refereeEmail` string, nullable — referee email for referred candidate application - `profileId` integer, nullable — profile id of candidate application - `utm_source` string, nullable — utm source for the application - `feedback` ProfileFeedback - `createdAt` string, date-time, nullable — Datetime when this feedback was created - `plannedEventId` integer, nullable — Planned event id for candidate source - `feedbackResponse` ProfileFeedbackResponse - `overallFeedback` ProfileFeedbackQuestionAnswer - `answer` string, nullable — Answer - `label` string, nullable — Label - `questionId` integer, nullable — Question ID - `comment` string, nullable — Comment - `feedback` ProfileFeedbackQuestionAnswer[], nullable — Ordered list of answers in the feedback (one per question on the form). Frontend should drive form rendering off this typed list rather than parsing the raw `feedbackJson` string. - `answer` string, nullable — Answer - `label` string, nullable — Label - `questionId` integer, nullable — Question ID - `comment` string, nullable — Comment - `followUpEnabled` boolean, nullable — Denotes if the feedback follow up is enabled or not - `profileId` integer, nullable — Profile ID associated with the profile feedback - `communityId` integer, nullable — Community Id for candidate source - `sharedFeedbackMessageId` integer, nullable — Message Id for shared feedback - `viewFeedbackUrl` string, nullable — URL to view feedback - `requestedAt` integer, nullable — Timestamp when the feedback was requested - `reminderCount` integer, nullable — Number of reminders sent - `requester` UserLogin - `fullName` string, nullable — Full name of User - `redirectEmail` string, nullable — Redirect Email - `domain` string, nullable — Domain name for User - `email` string, nullable — Email of User - `submittedAt` integer, nullable — Timestamp when the feedback was first submitted - `reviewerEmail` string, nullable — Email of reviewer of the ProfileFeedback - `feedbackType` string, nullable — type of the feedback - `feedbackTemplateId` integer, nullable — Feedback template ID - `feedbackEncId` string, nullable — Encoded ID of the ProfileFeedback - `requesterEmail` string, nullable — Email of requester of the ProfileFeedback - `archiveFlag` boolean, nullable — Denotes if the feedback is archived or not - `position` Position - `createdAt` integer, nullable — Creation timestamp in epoch format - `confidential` boolean, nullable — if the position is confidential or not - `hiringManager` Person - `email` string, nullable — email - `name` string, nullable, required — Name - `groupId` string, nullable — group id - `name` string, nullable, required — Title of the Position - `followers` string[], nullable — all the followers of the position - `jobDescription` string, nullable — Detailed Job Description in a text format - `systemId` string, nullable — system id - `positionDisplayId` string, nullable — display job id - `recruiter` Person - `email` string, nullable — email - `name` string, nullable, required — Name - `calibrationConfirmedBy` string, nullable — User who confirmed the calibration - `open` boolean, nullable — if the position is open or not - `createdBy` string, nullable — source of the job - `calibrationConfirmedAt` integer, nullable — Confirmed timestamp for the calibration - `atsData` ATSPositionData - `createdAt` integer, nullable, required — creation timestamp in epoch format - `locationCountry` string, nullable — Country of the location - `coordinators` Person[], nullable — all the coordinators related to this position - … - `businessUnit` string, nullable — business unit - `isPrivate` boolean, nullable — Indicates if a position is a private posting - `workLocationOption` string, nullable — Indicates the option for working location e.g. onsite, remote_global, remote_local, hybrid - `atsEntityId` string, nullable, required — position_id in the ats system - `hiringManager` Person - … - `internalPostingUrl` string, nullable — internal posting url - `evergreen` boolean, nullable — is evergreen - `skills` string[], nullable — skills - `company` string, nullable, required — company - `locationCity` string, nullable — City of the location - `lastUpdated` integer, nullable, required — last modified date time in epoch format - `displayJobId` string, nullable — display job id - `openings` AtsOpenings - … - `hiringTeam` HiringTeamMember[], nullable — Unified hiring team array. Each entry: {role, roleKey, name, email}. Includes primary/secondary HMs, primary/secondary recruiters, and custom roles. - … - `followers` Person[], nullable — all the followers of the positions as hiring managers etc. - … - `startDate` string, nullable — start date of the position in ISO 8601 format (e.g. 2024-05-01) - `requisitionType` string, nullable — Requisition Type - `systemId` string, nullable — system id - `activities` PositionActivities[], nullable — all the activities related to this positions - … - `postedFor` string, nullable — internal for internal jobs, external for external jobs, or all for both. Can be omitted for unposted positions.Input values must be one of these: internal, external, all, None - `questionnaires` Questionnaire[], nullable — questionnaires - … - `restrictAccess` boolean, nullable — restrict access - `title` string, nullable, required — job title - `templateId` integer, nullable — Template id of the template used to create the position - `recruiter` Person, required - … - `jobPosts` JobPost[], nullable — job postings - … - `hiringBand` string, nullable — hiring band - `postingTitle` string, nullable — posting title - `employmentType` string, nullable — Employment Type - `posted` boolean, nullable, required — status of the position posted or not - `locationFlexibility` string, nullable — Indicates the flexibility on location e.g. not_flexible, flexible_within_country, flexible_global - `orgUnits` object, nullable — Org units of the position - `companyDescription` string, nullable — Company description - `customFields` object, nullable — custom fields - `sourcers` Person[], nullable — all the recruiters/sourcers related to this positions - … - `workflowTemplateId` string, nullable — Indicates which workflow this position belongs to - `status` string, nullable, required — status - `jobCode` string, nullable — ATS attribute which identifies the job this jobrequestion is mapped to - `open` boolean, nullable, required — status of the position open or not - `postingUrl` string, nullable — posting url - `atsUserGroups` AtsUserGroups[], nullable — ATS user groups - … - `createdBy` string, nullable — Email of the user who created this position - `function` string, nullable — job function - `jobStages` string[], nullable — job_stages - `requiredSkills` string[], nullable — required skills - `questions` Questions[], nullable — questions - … - `locationState` string, nullable — State of the location - `locations` string[], nullable — location - `positionId` integer, nullable — EF Position ID - `description` string, nullable — job description - `calibrationData` CalibrationData - `flags` string[], nullable — flags - `graduationYear` string, nullable — graduationYear - `workCategories` string[], nullable — workCategories - `skills` string[], nullable — skills - `diversity` string[], nullable — diversity - `idealCandidates` string[], nullable — ideal_candidates - `companies` string[], nullable — companies - `titles` string[], nullable — titles - `educationLevel` string[], nullable — different education levels - `relocation` string[], nullable — relocation - `seniorities` string[], nullable — seniorities - `maxExperience` integer, nullable — maxExperience - `schools` string[], nullable — schools - `skillProficiencies` SkillProficiency[], nullable — skill proficiencies of the role - … - `idealCandidateUrls` string[], nullable — idealCandidatesUrls - `minExperience` integer, nullable — minExperience - `notes` string, nullable — notes - `locations` string[], nullable — locations - `role` Role - `templates` CalibrationTemplate[], nullable — all calibration templates associated with the role - … - `name` string, nullable — name of the role - `positionId` integer, nullable — job id - `userCalendarEventId` integer, nullable — User calendar event id - `feedbackId` integer, nullable — ID of the ProfileFeedback - `feedbackTemplateName` string, nullable — Feedback template name - `reviewer` UserLogin - `fullName` string, nullable — Full name of User - `redirectEmail` string, nullable — Redirect Email - `domain` string, nullable — Domain name for User - `email` string, nullable — Email of User - `plannedEvent` PlannedEvent - `createdAt` integer, nullable — Timestamp when this event was created - `isCancelled` boolean, nullable - `eventSpeakers` string[], nullable — List of speakers - `activeRegistrations` string, nullable — active registrations - `registerButton` RegisterButton - `textColor` string, nullable — text color for registration button - `backgroundColor` string, nullable — background color of registration button - `text` string, nullable — Text of registration button - `eventTeamDataJson` object, nullable — Event team data - `eventBucket` string, nullable — Bucket of the event - `address` string, nullable — Address of venue - `eventCustomFieldsJson` object, nullable — Event custom fields - `eventType` string, nullable - `institution` string, nullable — Institution related to event - `selectedTimezone` string, nullable — Selected time zome - `name` string, nullable — Name of the event - `homePageBanner` HomePageBanner - `useImage` boolean, nullable — boolean value for using image - `image` string, nullable — image of home page banner - `title` string, nullable — title for home page - `eventLocationType` string, nullable - `id` string, nullable — id - `parentId` string, nullable — Parent id of the event - `venue` string, nullable — Venue of the event - `endTimestamp` integer, nullable — Ending timestamp of event - `isPublished` boolean, nullable - `eventLandingPage` string, nullable — Event landing page - `status` string, nullable - `createdBy` string, nullable — User id which created this event - `eventCategory` string, nullable — Category of the event - `startTimestamp` integer, nullable — Starting time stamp of event - `when` string, nullable — When tag of the event - `description` string, nullable — Description of event - `matchingData` ApplicationMatchScore[], nullable — Application matching information - `topMatches` string[], nullable — The top few items driving this score (e.g. the matched skills or title terms), up to 3 - `indeterminable` integer, nullable — 1 when there wasn't enough data to compute this score (score will be -1), otherwise 0 - `score` integer, nullable — Match strength for this aspect on a 0-5 scale (higher is a better match); -1 when it could not be determined - `relevantScoreTypeVal` integer, nullable — A supporting count eg: matching skills (skill) or relevant years of experience (experience). Null when not applicable - `scoreRaw` number, float, nullable — The underlying un-rounded score behind the 0-5 rating (e.g. raw overall stars); may be null when not applicable - `scoreType` string, nullable — Which aspect of the match this score describes eg- overall fit, skill, title, or experience - `status` string, nullable — status of the feedback - `feedbackJson` object, nullable — Feedback JSON - `feedbackUrl` string, nullable — URL to provide feedback - `positionId` string, nullable — Position ID for which feedback was given - `groupId` string, nullable, required - `applicationStatus` string, nullable, required — application status of candidate application - `isInternal` boolean, nullable — Is application internal one - `isReferral` boolean, nullable — Is application a referral one - `customInfo` object, nullable — custom info for the application - `candidateId` string, nullable, required — candidate id of candidate application - `visaStatus` string, nullable — visa status of candidate application - `comment` string, nullable — Comment added during stage advance - `positionTitle` string, nullable, required — Position title of candidate application - `id` string, nullable — object id of the profile application - `position` Position - `createdAt` integer, nullable — Creation timestamp in epoch format - `confidential` boolean, nullable — if the position is confidential or not - `hiringManager` Person - `email` string, nullable — email - `name` string, nullable, required — Name - `groupId` string, nullable — group id - `name` string, nullable, required — Title of the Position - `followers` string[], nullable — all the followers of the position - `jobDescription` string, nullable — Detailed Job Description in a text format - `systemId` string, nullable — system id - `positionDisplayId` string, nullable — display job id - `recruiter` Person - `email` string, nullable — email - `name` string, nullable, required — Name - `calibrationConfirmedBy` string, nullable — User who confirmed the calibration - `open` boolean, nullable — if the position is open or not - `createdBy` string, nullable — source of the job - `calibrationConfirmedAt` integer, nullable — Confirmed timestamp for the calibration - `atsData` ATSPositionData - `createdAt` integer, nullable, required — creation timestamp in epoch format - `locationCountry` string, nullable — Country of the location - `coordinators` Person[], nullable — all the coordinators related to this position - `email` string, nullable — email - `name` string, nullable, required — Name - `businessUnit` string, nullable — business unit - `isPrivate` boolean, nullable — Indicates if a position is a private posting - `workLocationOption` string, nullable — Indicates the option for working location e.g. onsite, remote_global, remote_local, hybrid - `atsEntityId` string, nullable, required — position_id in the ats system - `hiringManager` Person - `email` string, nullable — email - `name` string, nullable, required — Name - `internalPostingUrl` string, nullable — internal posting url - `evergreen` boolean, nullable — is evergreen - `skills` string[], nullable — skills - `company` string, nullable, required — company - `locationCity` string, nullable — City of the location - `lastUpdated` integer, nullable, required — last modified date time in epoch format - `displayJobId` string, nullable — display job id - `openings` AtsOpenings - `closedAt` integer, nullable — Closing timestamp in epoch format - `openingDetails` AtsOpeningDetail[], nullable — Details of the openings - … - `numOpenings` integer, nullable — Number of openings. Set to -1 for unlimited openings - `openedAt` integer, nullable — Opening timestamp in epoch format - `numOpeningsFilled` integer, nullable — Number of openings filled - `hiringTeam` HiringTeamMember[], nullable — Unified hiring team array. Each entry: {role, roleKey, name, email}. Includes primary/secondary HMs, primary/secondary recruiters, and custom roles. - `role` string, nullable — Role label (e.g. Hiring Manager, HRBP) - `email` string, nullable — Email of the team member - `name` string, nullable — Name of the team member - `roleKey` string, nullable — Storage key for the role (e.g. hiring_manager, secondary_hiring_managers, cust_hrbp) - `followers` Person[], nullable — all the followers of the positions as hiring managers etc. - `email` string, nullable — email - `name` string, nullable, required — Name - `startDate` string, nullable — start date of the position in ISO 8601 format (e.g. 2024-05-01) - `requisitionType` string, nullable — Requisition Type - `systemId` string, nullable — system id - `activities` PositionActivities[], nullable — all the activities related to this positions - `activityTime` integer, nullable, required — activity time in epoch format - `activityType` string, nullable, required — activity type - `changeLogs` ChangeLog[], nullable — all the change logs for the activity - … - `message` string, nullable, required — message for the activity - `postedFor` string, nullable — internal for internal jobs, external for external jobs, or all for both. Can be omitted for unposted positions.Input values must be one of these: internal, external, all, None - `questionnaires` Questionnaire[], nullable — questionnaires - `questionDependencies` QuestionDependencies[], nullable — question dependencies - … - `questionnaireId` string, nullable, required — questionnaire id - `restrictAccess` boolean, nullable — restrict access - `title` string, nullable, required — job title - `templateId` integer, nullable — Template id of the template used to create the position - `recruiter` Person, required - `email` string, nullable — email - `name` string, nullable, required — Name - `jobPosts` JobPost[], nullable — job postings - `publishedTime` integer, nullable, required — published time in epoch format - `expirationTime` integer, nullable — expiration time in epoch format - `postingTitle` string, nullable, required — posting title - `postingId` string, nullable, required — posting id - `locale` string, nullable — locale of the ats job post - `primaryPost` boolean, nullable — is primary post - `jobDescription` string, nullable — job description - `postedFor` string, nullable, required — internal for internal jobs, external for external jobs, or all for both. - `hiringBand` string, nullable — hiring band - `postingTitle` string, nullable — posting title - `employmentType` string, nullable — Employment Type - `posted` boolean, nullable, required — status of the position posted or not - `locationFlexibility` string, nullable — Indicates the flexibility on location e.g. not_flexible, flexible_within_country, flexible_global - `orgUnits` object, nullable — Org units of the position - `companyDescription` string, nullable — Company description - `customFields` object, nullable — custom fields - `sourcers` Person[], nullable — all the recruiters/sourcers related to this positions - `email` string, nullable — email - `name` string, nullable, required — Name - `workflowTemplateId` string, nullable — Indicates which workflow this position belongs to - `status` string, nullable, required — status - `jobCode` string, nullable — ATS attribute which identifies the job this jobrequestion is mapped to - `open` boolean, nullable, required — status of the position open or not - `postingUrl` string, nullable — posting url - `atsUserGroups` AtsUserGroups[], nullable — ATS user groups - `userGroupId` string, nullable — Ats Group of a user - `createdBy` string, nullable — Email of the user who created this position - `function` string, nullable — job function - `jobStages` string[], nullable — job_stages - `requiredSkills` string[], nullable — required skills - `questions` Questions[], nullable — questions - `choices` QuestionChoice[], nullable — Question choices - … - `choicesV2` QuestionLabel[], nullable — Question choices V2. It supports language mapping. - … - `questionId` string, nullable, required — question_id - `help` string, nullable — help - `type` string, nullable — type of the question. e.g.-choice, numeric or text - `question` QuestionLabel - … - `required` boolean, nullable — required - `locationState` string, nullable — State of the location - `locations` string[], nullable — location - `positionId` integer, nullable — EF Position ID - `description` string, nullable — job description - `calibrationData` CalibrationData - `flags` string[], nullable — flags - `graduationYear` string, nullable — graduationYear - `workCategories` string[], nullable — workCategories - `skills` string[], nullable — skills - `diversity` string[], nullable — diversity - `idealCandidates` string[], nullable — ideal_candidates - `companies` string[], nullable — companies - `titles` string[], nullable — titles - `educationLevel` string[], nullable — different education levels - `relocation` string[], nullable — relocation - `seniorities` string[], nullable — seniorities - `maxExperience` integer, nullable — maxExperience - `schools` string[], nullable — schools - `skillProficiencies` SkillProficiency[], nullable — skill proficiencies of the role - `proficiency` number, float, nullable — proficiency of the role - `skillGroupList` SkillGroupList[], nullable — skill group list of a role - … - `level` string, nullable — level of the role - `name` string, nullable — name of the role - `idealCandidateUrls` string[], nullable — idealCandidatesUrls - `minExperience` integer, nullable — minExperience - `notes` string, nullable — notes - `locations` string[], nullable — locations - `role` Role - `templates` CalibrationTemplate[], nullable — all calibration templates associated with the role - `id` integer, nullable — id of the calibration template - `name` string, nullable — Name of the calibration template - `name` string, nullable — name of the role - `positionId` integer, nullable — job id - `applicationTime` integer, nullable, required — application time of candidate application - `sourceName` string, nullable — source name of candidate application - `utm_campaign` string, nullable — utm campaign for the application - `matchingData` ApplicationMatchScore[], nullable - `topMatches` string[], nullable — The top few items driving this score (e.g. the matched skills or title terms), up to 3 - `indeterminable` integer, nullable — 1 when there wasn't enough data to compute this score (score will be -1), otherwise 0 - `score` integer, nullable — Match strength for this aspect on a 0-5 scale (higher is a better match); -1 when it could not be determined - `relevantScoreTypeVal` integer, nullable — A supporting count eg: matching skills (skill) or relevant years of experience (experience). Null when not applicable - `scoreRaw` number, float, nullable — The underlying un-rounded score behind the 0-5 rating (e.g. raw overall stars); may be null when not applicable - `scoreType` string, nullable — Which aspect of the match this score describes eg- overall fit, skill, title, or experience - `currentStage` string, nullable — Current stage of candidate application - `sourceType` string, nullable — source type of candidate application - `isInTalentNetwork` boolean, nullable — Is candidate in talent network - `isCareerSite` boolean, nullable — Is application from career site - `actionUser` Person - `email` string, nullable — email - `name` string, nullable, required — Name - `atsJobId` string, nullable, required — name of candidate application - `positionId` integer, nullable, required — Position id of candidate application - `applicationId` string, required — application id of candidate application - `customFields` object, nullable — ats custom fields key-value pairs, key is the field name - `certificates` CertificateSchema[], nullable — Certificates - `verificationStatus` string, nullable — verification status of a certification - `country` string, nullable — Certificate issued country - `skills` string[], nullable — Skills associated with the certification - `comments` string, nullable — Comments on the certification - `validFromDate` string, nullable — Valid From Date - `date` string, nullable — Certificate issue date - `allText` string[], nullable — All text associated with the certification - `source` string, nullable — source - `startDate` string, nullable — Start date - `validToDate` string, nullable — Valid To Date - `certificateId` string, nullable — License number of a certification - `state` string, nullable — Certificate issued state - `title` string, nullable, required — Title of certificate - `endDate` string, nullable — End date - `verificationBy` string, nullable — email of the verifier - `externalKey` string, nullable — External key - `verificationTs` integer, nullable — verification timestamp - `status` string, nullable — Certificate status - `certificateType` string, nullable — Type of certificate - `proficiency` string, nullable — proficiency of a certification - `attachmentIds` string[], nullable — List of attachment ids of the certification - `certificateExternalId` string, nullable — external id for the type of certification - `issuingAuthority` string, nullable — Certificate issuing authority - `description` string, nullable — Certificate description - `publications` Publication[], nullable — publications of candidate - `date` string, nullable — Patent date - `skills` string[], nullable — Publication skills - `publisher` string, nullable — Patent publisher - `description` string, required — Patent description - `title` string, nullable — Patent title - `notes` Note[], nullable — Image Url of candidate - `creatorEmail` string, nullable — creator email of candidate - `id` string, nullable — Note id of candidate - `noteType` string, nullable — Note type of candidate - `note` string, nullable — Note of candidate - `profileId` string, nullable — Profile id of candidate - `positionId` string, nullable — Position id associated with the note - `createdTime` integer, nullable — created time of candidate in datetime format - `gender` string, nullable — Gender of candidate - `atsData` ATSProfileSchema - `locationCountry` string, nullable — location country of candidate - `contactConsent` string, nullable — Contact consent for candidate. Valid inputs: applied_only, all, country_only - `isAnonymized` boolean, nullable — is anonymized candidate - `scheduledInterviews` ATSScheduledInterview[], nullable — scheduled interviews of candidate - `organizer` string, nullable — Organizer - `status` string, nullable — Status - `endTs` integer, nullable — End Timestamp - `interviewType` string, nullable — Interview Type - `interviewers` string[], nullable — Interviewers - `startTs` integer, nullable — Start Timestamp - `location` string, nullable — Location of interview - `comment` string, nullable — Comment - `referenceId` string, nullable — Reference ID - `skills` string[], nullable — skills of candidate - `location` string, nullable — location of candidate - `address` string, nullable — address of candidate - `firstName` string, required — first name of candidate - `emails` string, nullable, required — email of candidate - `detailTags` AtsTag[], nullable — detail tags of candidate - `tag` string, nullable, required — tag of candidate - `jobId` string, nullable — job id for a tag - `creator` string, nullable — creator of tag - `tagSubtype` string, nullable — tag subtype - `tagType` string, nullable — tag type - `creationTs` integer, nullable — creation timestamp of tag - `attachments` AtsAttachment[], nullable — Attachments of candidate - `isBase64` boolean, nullable — Denotes if the attachment base64 encoded - `fileName` string, required — File name of the attachment - `lastModifiedTs` integer, nullable — Last Modified timestamp of the attachment - `applicationMetadata` AtsAttachmentApplicationMetadata[], nullable — application_metadata - `applicationId` string, required — application id for an attachment - `attachmentContent` string, nullable, required — Content of the attachment - `attachmentId` string, required — Attachment id of the attachment - `attachmentType` string, nullable, required — Attachment type. Valid inputs: resume, others, photo, cover_letter - `resumeContent` AtsContent - `extension` string, nullable — extension - `content` string, nullable — content - `isBase64` boolean, nullable — is base 64 encoded? - `visaStatuses` string[], nullable — visa statuses of candidate - `veteranStatusStr` string, nullable — String value for veteran status of the candidate - `education` AtsEducation[], nullable — education of candidate - `endTs` integer, nullable — ending timestamp - `verificationStatus` string, nullable — verification status of the education details - `degreeExternalId` string, nullable — external id of the degree - `attachmentIds` string[], nullable — List of attachment ids of the education - `startTs` integer, nullable, required — starting timestamp of education - `degree` string, nullable, required — degree - `major` string, nullable, required — major - `verificationBy` string, nullable — email of the verifier - `location` string, nullable, required — location - `isCurrent` boolean, nullable — is current education - `schoolExternalId` string, nullable — external id of the school - `majorExternalId` string, nullable — external id of the major - `verificationTs` integer, nullable — verification timestamp - `school` string, nullable, required — school - `nameAlias` string, nullable — name of the candidate in the records if different from the name in the profile - `isGraduated` boolean, nullable — graduation status of the candidate - `description` string, nullable, required — description - `isInternal` boolean, nullable — is internal candidate - `customInfo` object, nullable — custom info of candidate - `courseAttendance` LmsCourseAttendance[], nullable — course attandance of candidate - `durationHours` number, float, nullable — Duration of the course (in hours) - `percentageCompletion` number, float, nullable — Percentage Completion - `isInternal` boolean, nullable — Is Internal - `pointsEarned` number, float, nullable — Points Earned - `courseType` string, nullable — Course type - `difficulty` string, nullable — difficulty - `courseUrl` string, nullable — Course Url - `title` string, nullable — Title. Note: Course Id or title must be present. - `completionTs` integer, nullable — Completion Timestamp - `lmsCourseId` string, nullable — LMS Course Id. Note: Course Id or title must be present. - `medium` string, nullable — medium - `language` string, nullable — Language - `dueTs` integer, nullable — Due Timestamp - `assignedBy` string, nullable — Email of who assigned this course - `status` string, nullable — status - `startTs` integer, nullable — Start timestamp - `isMandatory` boolean, nullable — is course attendance mandatory ? - `provider` string, nullable — provider - `verified` string, nullable — verified - `description` string, nullable — description - `systemId` string, nullable — system if of candidate - `urls` string[], nullable — urls of candidate - `candidateId` string, nullable, required — ATS Candidate id - `title` string, nullable — title of candidate - `displayTags` string[], nullable — display tags for candidate - `tags` string[], nullable — tags of candidate - `veteranStatus` boolean, nullable — Boolean value for veteran status of the candidate - `highestEducationLevel` string, nullable — highest education level of candidate - `certifications` AtsCertification[], nullable — certifications for candidate - `locationCountry` string, nullable — Country where certification was issued - `verificationStatus` string, nullable — verification status of a certification - `licenseNo` string, nullable — License number of a certification - `skills` string[], nullable — Skills associated with the certification - `validFromTs` integer, nullable — validtion from timestamp of a certification - `comments` string, nullable — Comments on the certification - `allText` string, nullable — All text associated with the certification - `endTs` integer, nullable — ending timestamp of a certification - `verificationBy` string, nullable — email of the verifier - `certificateName` string, nullable, required — certificate name of a certification - `verificationTs` integer, nullable — verification timestamp - `status` string, nullable — Status of the certification - `certificateType` string, nullable — Type of the certification - `proficiency` string, nullable — proficiency of a certification - `validToTs` integer, nullable — validation till timestamp of a certification - `attachmentIds` string[], nullable — List of attachment ids of a certification - `startTs` integer, nullable — starting timestamp of a certification - `certificateExternalId` string, nullable — external id for the type of certification - `locationState` string, nullable — State where certification was issued - `issuingAuthority` string, nullable — issuing authority of a certification - `description` string, nullable — Description of the certification - `lastActivityTs` integer, nullable, required — last activity time stamp of candidate - `summary` string, nullable — summary of candidate - `photoContent` AtsContent - `extension` string, nullable — extension - `content` string, nullable — content - `isBase64` boolean, nullable — is base 64 encoded? - `applications` AtsApplication[], nullable — applications of candidates - `locationCountry` string, nullable — location country of an application - `reason` string, nullable — reason for an application - `location` string, nullable — location of an application - `visaStatuses` string[], nullable — list of visa status - `veteranStatusStr` string, nullable — String value for veteran status of the applicant - `jobs` Jobs[], nullable — Jobs related to an application. - `atsJobId` string, nullable — ATS Job id - `name` string, nullable — Name - `hiredTs` integer, nullable — hired timestamp of an applicant - `lastModifiedTs` integer, nullable, required — last modified timestamp of an application - `customInfo` object, nullable — custom info for an application - `note` AtsNote - `subject` string, nullable — subject of a note - `to` string, nullable — email of reciever - `noteType` string, nullable — Note type of an ats note. Valid inputs: email, note, other - `visibility` string, nullable — visibility of a note - `creator` string, nullable — creator of a note - `cc` string[], nullable — email address for cc - `body` string, nullable — body of a note - `sender` string, nullable — email of sender - `creationTs` integer, nullable — creation timestamp of a note - `systemId` string, nullable — system id of an application - `creditor` string, nullable — creditor of an application - `candidateId` string, nullable, required — candidate id of an applicant - `rejectedTs` integer, nullable — rejected timestamp of an applicant - `veteranStatus` boolean, nullable — Boolean value for veteran status of the applicant - `applicationTs` integer, nullable, required — application timestamp - `pastStages` AtsStage[], nullable — past stages of an application - `stage` string, nullable — stage - `user` AtsUser, required - `userId` string, nullable — user id - `email` string, nullable — email of user - `name` string, nullable — name of user - `atsRoles` string[], nullable — list of ats roles - `reason` string, required — reason - `wfSubStage` string, required — wf sub stage - `wfStage` string, required — wf stage - `stageTs` integer, required — stage timestamp - `sourceName` string, nullable — source name of an application - `isProspect` boolean, nullable — is prospective applicant - `scorecards` AtsScorecard[], nullable — scorecards for an application - `overallRatingLabel` string, nullable — overall rating label - `overallRating` string, nullable — Overall rating. Valid inputs: strong_yes, yes, mixed, no, strong_no - `submittedBy` AtsUser - `userId` string, nullable — user id - `email` string, nullable — email of user - `name` string, nullable — name of user - `atsRoles` string[], nullable — list of ats roles - `submittedAt` integer, nullable — submitted at timestamp - `interviewedAt` integer, nullable — interview at timestamp - `attributes` ATSScoreCardAttribute[], nullable — attributes - `rating` string, nullable — Rating. Valid inputs: strong_yes, yes, mixed, no, strong_no - `answer` string, nullable — Answer - `note` string, nullable — Note - `question` string, nullable — Question - `rating_label` string, nullable — Rating label - `description` string, nullable — description of interview - `interviewName` string, nullable — interview name - `jobSystemId` string, nullable — job system id for an application - `disabilityStatus` boolean, nullable — disability status of an applicant - `currentStage` AtsStage - `stage` string, nullable — stage - `user` AtsUser, required - `userId` string, nullable — user id - `email` string, nullable — email of user - `name` string, nullable — name of user - `atsRoles` string[], nullable — list of ats roles - `reason` string, required — reason - `wfSubStage` string, required — wf sub stage - `wfStage` string, required — wf stage - `stageTs` integer, required — stage timestamp - `status` string, nullable — Status of application.Valid inputs: active, hired, rejected, converted, withdrawn - `races` string[], nullable — list of races of an applicant - `sourceType` string, nullable — source type of an application - `gender` string, nullable — gender of an applicant - `questions` AtsQuestionAnswer[], nullable — questions - `formName` string, nullable — form name for the question - `choices` string[], nullable — choices of a question - `explanation` string, nullable — explaination of the question - `answer` string[], nullable — answer to the question - `formType` string, nullable — form type for the question - `questionId` string, required — question id - `displayOrder` string, nullable — display order of the question - `formId` string, nullable — form id for the question - `type` string, nullable — Type of question. Valid inputs: text, choice, dropdown, date, multi_value, numeric - `question` string, nullable — question data - `rejectedBy` string, nullable — applicant rejected by - `disabilityStatusStr` string, nullable — disability status of an applicant - `applicationId` string, required — application id - `disabilityStatus` boolean, nullable — disability status - `phones` string, nullable — comma separated phone numbers of candidate - `experience` AtsExperience[], nullable — experience of candidate - `endTs` integer, nullable — end_ts of exp - `industry` string, nullable — industry of work - `isInternal` boolean, nullable, required — is internal employee - `department` string, nullable — department of work - `startTs` integer, nullable, required — start_ts of exp - `location` string, nullable, required — location of work - `company` string, nullable, required — company of a candidate - `isCurrent` boolean, nullable, required — is currentely employed - `description` string, nullable — description of the post/company - `title` string, nullable, required — title of post - `races` string[], nullable — race of candidate - `dateOfBirth` string, nullable — date of birth of candidate - `project` AtsProject[], nullable — project of candidate - `endTs` integer, nullable — ending timestamp of a project - `links` string[], nullable — links for a project - `startTs` integer, nullable, required — start timestamp of a project - `skills` string[], nullable — skills - `company` string, nullable, required — company of a project - `contributors` string[], nullable — contributors to a project - `description` string, nullable — description - `title` string, nullable, required — title of a project - `notes` AtsNote[], nullable — notes of candidates - `subject` string, nullable — subject of a note - `to` string, nullable — email of reciever - `noteType` string, nullable — Note type of an ats note. Valid inputs: email, note, other - `visibility` string, nullable — visibility of a note - `creator` string, nullable — creator of a note - `cc` string[], nullable — email address for cc - `body` string, nullable — body of a note - `sender` string, nullable — email of sender - `creationTs` integer, nullable — creation timestamp of a note - `gender` string, nullable — gender of candidate - `questions` AtsQuestionAnswer[], nullable — questions of candidate - `formName` string, nullable — form name for the question - `choices` string[], nullable — choices of a question - `explanation` string, nullable — explaination of the question - `answer` string[], nullable — answer to the question - `formType` string, nullable — form type for the question - `questionId` string, required — question id - `displayOrder` string, nullable — display order of the question - `formId` string, nullable — form id for the question - `type` string, nullable — Type of question. Valid inputs: text, choice, dropdown, date, multi_value, numeric - `question` string, nullable — question data - `skillDetails` ATSSkillDetail[], nullable — skill details of candidate - `skillGroups` ATSSkillGroup[], nullable — Skill groups - `proficiency` string, nullable — Proficiency - `skillGroup` string, nullable — Skill Group - `proficiency` string, nullable — Proficiency. Note: proficiency must be specified only for each skill group when skill groups are present - `evaluationTimestamp` integer, nullable — Evaluation timestamp - `dataSource` string, nullable — Data source of the skill - `skill` string, nullable — Skill - `disabilityStatusStr` string, nullable — disability status of an applicant - `lastName` string, nullable — last name of candidate - `industries` string[], nullable — Industries in which candidate has worked - `efGender` string, nullable — Gender inferred by Eightfold - `inferredSkills` InferredSkillsSchema[], nullable — List of inferred skills for each experience of profile - `skillType` string, nullable — The type of the skills, validated skills or likely skills - `skills` string[], nullable — The list of skills - `attachmentsInfo` ProfileAttachmentSchema[], nullable — Attachments metadata of the profile - `lastModifiedTs` integer, nullable — Last modified timestamp of the attachment - `attachmentID` string, nullable — Id of the attachment - `attachmentType` string, nullable — Type of the attachment e.g.resume, photo, others - `filename` string, nullable — Name of the file - `lastName` string, nullable — Last Name of candidate - `meta` MetaSchema - `totalCount` integer, nullable - `pageTotalCount` integer, nullable - `pageStartIndex` integer, nullable --- [API](https://skmtc.net/eightfold/apis/api-server-v2-service-service.md) · [All operations](https://skmtc.net/eightfold/apis/api-server-v2-service-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eightfold/api-server-v2-service-service/versions/0fb26f4e41bf/schema)