Recruiting Candidates
recruitingCandidates Based on latest (2026.09)
Create, change, delete and look up Recruiting Candidates, with candidate address, candidate phones and citizenships.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
CandidateNumber- Required on create
- none marked
- At a glance
- 27 fields2 finders10 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/recruitingCandidates?fields=CampaignOptIn,CandLastModifiedDate,CandidateNumber,CandidateType,CreatedBy&limit=25&onlyData=true
{
"items": [
{
"CampaignOptIn": "<string, max 1>",
"CandLastModifiedDate": "2026-01-31T09:00:00+00:00",
"CandidateNumber": "<string>",
"CandidateType": "<string>",
"CreatedBy": "<string>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 27
| Attribute | Type | Use |
|---|---|---|
CampaignOptIn | text · max 1 | Optional on createUpdatable |
CandLastModifiedDate | date-time | Optional on createUpdatableSearchable |
CandidateNumber | text | Read-only |
CandidateType | text | Read-onlySearchable |
CreatedBy | text | Optional on create |
CreationDate | date-time | Optional on create |
DisplayName | text | Read-only |
Email | text · max 240 | Optional on createUpdatable |
FirstName | text · max 150 | Optional on createUpdatable |
FullName | text | Read-onlySearchable |
Honors | text · max 80 | Optional on createUpdatable |
KnownAs | text · max 80 | Optional on createUpdatable |
LastName | text · max 150 | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Optional on create |
LastUpdatedBy | text | Optional on create |
ListName | text | Read-only |
MiddleNames | text · max 80 | Optional on createUpdatable |
MilitaryRank | text · max 80 | Optional on createUpdatable |
PersonId | number | Read-only |
PreNameAdjunct | text · max 150 | Optional on createUpdatable |
PreferredLanguage | text · max 4 | Optional on createUpdatable |
PreferredTimezone | text · max 255 | Optional on createUpdatableSearchable |
PreviousLastName | text · max 150 | Optional on createUpdatable |
SourceMedium | text · max 32 | Optional on createUpdatable |
SourceName | text · max 2000 | Optional on createUpdatable |
Suffix | text · max 80 | Optional on createUpdatable |
Title | text · max 30 | Optional on createUpdatable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByPersonId·personIdsearch·keywords
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 10
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/<name>. Add them to a GET with expand.
attachmentsGET · POST · PATCH · DELETE Attachments of the Candidates · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamecandidateAddressGET · POST · PATCH · DELETE Address of the Recruiting Candidates · 24 fieldsAddlAddressAttribute1AddlAddressAttribute2AddlAddressAttribute3AddlAddressAttribute4AddlAddressAttribute5AddressIdAddressLine1AddressLine2AddressLine3BuildingCityCountryCreatedByCreationDateFloorNumberFormattedMultiLineAddressFormattedSingleLineAddressLastUpdateDateLastUpdatedByLongPostalCodePostalCodeRegion1Region2Region3candidatePhonesGET · POST · PATCH · DELETE Phone of the Recruiting Candidates · 11 fieldsAreaCodeCountryCodeNumberCreatedByCreationDateLastUpdateDateLastUpdatedByLegislationCodePhoneIdPhoneNumberPhoneTypeSearchPhoneNumbercitizenshipsGET · POST · PATCH · DELETE Citizenships of Candidates · 11 fieldsCitizenshipCitizenshipIdCitizenshipMeaningCitizenshipStatusCitizenshipStatusMeaningCreatedByCreationDateFromDateLastUpdateDateLastUpdatedByToDateeducationGET · POST · PATCH · DELETE Education of the Recruiting Candidates · 47 fieldsAcademicStandingActivitySummaryAreaOfStudyAverageGradeAwardingBodyCityCommentsCompletedAmountCompletedTraningUnitsContentItemIdCountryCodeCountryIdDateAcquiredDegreeNameDepartmentDescriptionDurationDurationUnitsEduLevelCompletedFlagEducationIdEducationLevelEducationURLEducationalEstablishmentEducationalEstablishmentIdEducatorEndDateFeeFeeCurrencyGPAGraduatedFlagHighestEduLevelMajorMinorPartTimeFlagProjectedCompletionDateReimbursementsRequiredFlagSectionIdStartDateStateProvinceCodeStateProvinceIdStatusTitleTotalAmountTrmnlDegDiscpFlagTuitionMethodYearAcquiredexperienceGET · POST · PATCH · DELETE Experience of the Recruiting Candidates · 36 fieldsAchievementsAdditionalInformationBusinessTypeCompanyURLContactSupervisorFlagCountryCodeCurrentJobFlagDepartmentDirectReportsEmployerCityEmployerCountryIdEmployerNameEmployerPhoneEmployerStateIdEndCompensationEndDateExperienceInYearsFullTimeCodeInternalFlagJobFamilyIdJobFunctionJobTitleLeavingReasonOtherCompensationOtherJobFunctionPreviousEmploymentIdResponsibilitiesSectionIdStartCompensationStartDateStartingPositionStateProvinceCodeSupervisorEmailSupervisorNameSupervisorPhoneSupervisorTitlelanguagesGET · POST · PATCH · DELETE Languages of the Recruiting Candidates · 16 fieldsAbleToTeachFlagAbleToTranslateFlagCommentsContentItemIdEvaluatedOnEvaluationLocationLanguageLanguageIdNativeSpeakerFlagReadingLevelIdReadingModelIdSectionIdSpeakingLevelIdSpeakingModelIdWritingLevelIdWritingModelIdlicensesAndCertificatesGET · POST · PATCH · DELETE Licenses and Certifications of the Recruiting Candidates · 29 fieldsActualCompletionDateCertificationIdCertificationNameCertificationNumberCertificationURLCommentsCompletedAmountCompletedTrainingUnitsContentItemIdCountryCodeCountryIdEducationalEstablishmentEducationalEstablishmentIdExpirationDateIssueDateIssuedByLastRenewalDateOriginalIssueYearRenewalDateRenewalInprogressFlagRenewalRequiredFlagRestrictionsSectionIdStateProvinceCodeStateProvinceIdStatusTitleTotalAmountVerifiedFlagskillsGET · POST · PATCH · DELETE Skills of the Recruiting Candidates · 10 fieldsCommentsContentItemIdDateAchievedDescriptionProjectNameSectionIdSkillSkillIdSpecialityYearsOfExperienceworkPreferencesGET · POST · PATCH · DELETE Work Preferences of the Recruiting Candidates · 36 fieldsAllLocationsFlagCommentsContentItemIdCurrencyCodeDateFromDateToExcludedLocationFourIdExcludedLocationOneIdExcludedLocationThreeIdExcludedLocationTwoIdFlexibleWorkFlagFullTimeEquivalentIntlTravelFlagIntlTravelFrequencyIntlTravelRequiredFlagMinimumPayNatTravelFlagNatTravelFrequencyNatTravelRequiredFlagPartAssignFlagPayFrequencyPayRangePreferredLocationFourIdPreferredLocationOneIdPreferredLocationThreeIdPreferredLocationTwoIdRelocateDurationRelocateFlagRelocationReasonSectionIdTempAssignFlagWorkDaysWorkHoursWorkMonthsWorkPreferenceIdWorkYears
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/recruitingCandidatesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByPersonIdfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:CampaignOptIn, notcampaignoptin. - 6 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.