HCM Contacts
hcmContacts Based on latest (2026.09)
Create, change and look up HCM Contacts, with addresses, citizenships and contact relationships.
The record key hcmContactsUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
Oracle documents an Effective-Of header and an effectiveDate parameter for this resource, used for date-effective reads and changes.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)
- Record key
hcmContactsUniqID- Required on create
- none marked
- At a glance
- 16 fields2 finders33 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/hcmContacts?fields=BloodType,BloodTypeMeaning,CorrLanguageMeaning,CorrespondenceLanguage,CountryOfBirth&limit=25&onlyData=true
{
"items": [
{
"BloodType": "<string, max 30>",
"BloodTypeMeaning": "<string, max 80>",
"CorrLanguageMeaning": "<string, max 80>",
"CorrespondenceLanguage": "<string, max 30>",
"CountryOfBirth": "<string, max 240>"
}
],
"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 16
| Attribute | Type | Use |
|---|---|---|
BloodType | text · max 30 | Optional on createUpdatable |
BloodTypeMeaning | text · max 80 | Read-onlySearchable |
CorrLanguageMeaning | text · max 80 | Read-onlySearchable |
CorrespondenceLanguage | text · max 30 | Optional on createUpdatable |
CountryOfBirth | text · max 240 | Optional on createUpdatable |
CountryOfBirthName | text · max 80 | Read-onlySearchable |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-only |
DateOfBirth | date | Optional on createUpdatableSearchable |
DateOfDeath | date | Optional on createUpdatable |
LastUpdateDate | date-time | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
PersonId | number | Optional on createSearchable |
PersonNumber | text · max 30 | Optional on createUpdatableSearchable |
RegionOfBirth | text · max 240 | Optional on createUpdatable |
TownOfBirth | text · max 240 | 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·PersonIdSysEffectiveDatefindContactsByWorker·ContactTypeEmergencyContactFlagRelatedPersonIdRelatedPersonNumberSysEffectiveDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 33
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/<name>. Add them to a GET with expand.
addressesGET · POST · PATCH · DELETE Addresses · 35 fields · 1 findersAddlAddressAttribute1AddlAddressAttribute2AddlAddressAttribute3AddlAddressAttribute4AddlAddressAttribute5AddressIdAddressLine1AddressLine2AddressLine3AddressLine4AddressTypeAddressTypeMeaningBuildingCountryCountryNameCreatedByCreationDateEffectiveEndDateEffectiveStartDateFloorNumberLastUpdateDateLastUpdatedByLatitudeLongPostalCodeLongitudePersonAddrUsageIdPostalCodePrimaryFlagProviderRegion1Region2Region3TownOrCityValidateAddressFlagValidationStatusCodeaddressesDFFGET · POST · PATCH Person Address Usage Descriptive Flexfields · 5 fieldsEffectiveEndDateEffectiveStartDatePersonAddrUsageId__FLEX_Context__FLEX_Context_DisplayValuecitizenshipsGET · POST · PATCH · DELETE Citizenships · 11 fieldsCitizenshipCitizenshipIdCitizenshipMeaningCitizenshipStatusCitizenshipStatusMeaningCreatedByCreationDateFromDateLastUpdateDateLastUpdatedByToDatecitizenshipsDFFGET · POST · PATCH Person Citizenships Descriptive Flexfields · 3 fieldsCitizenshipId__FLEX_Context__FLEX_Context_DisplayValuecontactRelationshipsGET · POST · PATCH · DELETE Contact Relationships · 17 fields · 1 findersContactRelationshipIdContactTypeContactTypeMeaningCreatedByCreationDateEffectiveEndDateEffectiveStartDateEmergencyContactFlagLastUpdateDateLastUpdatedByLegislationCodeLegislationNamePrimaryContactFlagRelatedPersonIdRelatedPersonNumberStatutoryDependentStatutoryDependentMeaningcontactRelationshipsDDFGET · POST · PATCH Contact Relationships Developer Descriptive FlexfieldsFields depend on your pod's flexfield setup (check
/describe).contactRelationshipsDFFGET · POST · PATCH Contact Relationships Descriptive Flexfields · 5 fieldsContactRelationshipIdEffectiveEndDateEffectiveStartDate__FLEX_Context__FLEX_Context_DisplayValuecontactsDFFGET · POST · PATCH Person Descriptive Flexfields · 3 fieldsPersonId__FLEX_Context__FLEX_Context_DisplayValuedriverLicensesGET · POST · PATCH · DELETE Driver Licenses · 19 fieldsCreatedByCreationDateDriversLicenseIdFromDateIssuingAuthorityIssuingCountryIssuingCountryNameIssuingLocationLastUpdateDateLastUpdatedByLicenseNumberLicenseSuspendedFlagLicenseTypeLicenseTypeMeaningNumberOfPointsSuspendedFromDateSuspendedToDateToDateViolationsdriverLicensesDDFGET · POST · PATCH Person Driver Licenses Developer Descriptive FlexfieldsFields depend on your pod's flexfield setup (check
/describe).driverLicensesDFFGET · POST · PATCH Person Driver Licenses Descriptive Flexfields · 3 fieldsDriversLicenseTypeId__FLEX_Context__FLEX_Context_DisplayValueemailsGET · POST · PATCH · DELETE Emails · 11 fieldsCreatedByCreationDateEmailAddressEmailAddressIdEmailTypeEmailTypeMeaningFromDateLastUpdateDateLastUpdatedByPrimaryFlagToDateemailsDFFGET · POST · PATCH Person Emails Descriptive Flexfields · 3 fieldsEmailAddressId__FLEX_Context__FLEX_Context_DisplayValueethnicitiesGET · POST · PATCH · DELETE Ethnicities · 10 fieldsCreatedByCreationDateEthnicityEthnicityIdEthnicityMeaningLastUpdateDateLastUpdatedByLegislationCodeLegislationNamePrimaryFlagethnicitiesDFFGET · POST · PATCH Person Ethnicities Descriptive Flexfields · 3 fieldsEthnicityId__FLEX_Context__FLEX_Context_DisplayValuelegislativeInfoGET · POST · PATCH · DELETE Legislative Information · 16 fields · 1 findersCreatedByCreationDateEffectiveEndDateEffectiveStartDateGenderGenderMeaningHighestEducationLevelHighestEducationLevelMeaningLastUpdateDateLastUpdatedByLegislationCodeLegislationNameMaritalStatusMaritalStatusChangeDateMaritalStatusMeaningPersonLegislativeIdlegislativeInfoDDFGET · POST · PATCH Person Legislative Developer Descriptive FlexfieldsFields depend on your pod's flexfield setup (check
/describe).legislativeInfoDFFGET · POST · PATCH Person Legislative Descriptive Flexfields · 5 fieldsEffectiveEndDateEffectiveStartDatePersonLegislativeId__FLEX_Context__FLEX_Context_DisplayValuenamesGET · POST · PATCH · DELETE Names · 112 fields · 1 findersCreatedByCreationDateDisplayNameEffectiveEndDateEffectiveStartDateFirstNameFullNameHonorsKnownAsLastNameLastUpdateDateLastUpdatedByLegislationCodeLegislationNameListNameLocalCreatedByLocalCreationDateLocalDisplayNameLocalEffectiveEndDateLocalEffectiveStartDateLocalFirstNameLocalFullNameLocalHonorsLocalKnownAsLocalLastNameLocalLastUpdateDateLocalLastUpdatedByLocalLegislationCodeLocalLegislationNameLocalListNameLocalMiddleNamesLocalMilitaryRankLocalNameInformation1LocalNameInformation10LocalNameInformation11LocalNameInformation12LocalNameInformation13LocalNameInformation14LocalNameInformation15LocalNameInformation16LocalNameInformation17LocalNameInformation18LocalNameInformation19LocalNameInformation2LocalNameInformation20LocalNameInformation21LocalNameInformation22LocalNameInformation23LocalNameInformation24LocalNameInformation25LocalNameInformation26LocalNameInformation27LocalNameInformation28LocalNameInformation29LocalNameInformation3LocalNameInformation30LocalNameInformation4LocalNameInformation5LocalNameInformation6LocalNameInformation7LocalNameInformation8LocalNameInformation9LocalNameLanguageLocalNameLanguageMeaningLocalOrderNameLocalPersonNameIdLocalPreNameAdjunctLocalPreviousLastNameLocalSuffixLocalTitleLocalTitleMeaningMiddleNamesMilitaryRankNameInformation1NameInformation10NameInformation11NameInformation12NameInformation13NameInformation14NameInformation15NameInformation16NameInformation17NameInformation18NameInformation19NameInformation2NameInformation20NameInformation21NameInformation22NameInformation23NameInformation24NameInformation25NameInformation26NameInformation27NameInformation28NameInformation29NameInformation3NameInformation30NameInformation4NameInformation5NameInformation6NameInformation7NameInformation8NameInformation9NameLanguageNameLanguageMeaningOrderNamePersonNameIdPreNameAdjunctPreviousLastNameSuffixTitleTitleMeaningnationalIdentifiersGET · POST · PATCH · DELETE National Identifiers · 14 fieldsCreatedByCreationDateExpirationDateIssueDateLastUpdateDateLastUpdatedByLegislationCodeLegislationNameNationalIdentifierIdNationalIdentifierNumberNationalIdentifierTypeNationalIdentifierTypeMeaningPlaceOfIssuePrimaryFlagnationalIdentifiersDFFGET · POST · PATCH Person National Identifiers Descriptive Flexfields · 3 fieldsNationalIdentifierId__FLEX_Context__FLEX_Context_DisplayValueotherCommunicationAccountsGET · POST · PATCH · DELETE Other Communication Accounts · 10 fieldsAccountNameCreatedByCreationDateDeliveryMethodIdEndDateLastUpdateDateLastUpdatedByProviderProviderMeaningStartDateotherCommunicationAccountsDFFGET · POST · PATCH Person Other Communication Accounts Descriptive Flexfields · 3 fieldsDeliveryMethodId__FLEX_Context__FLEX_Context_DisplayValuepassportsGET · POST · PATCH · DELETE Passports · 15 fieldsCreatedByCreationDateExpirationDateIssueDateIssuingAuthorityIssuingCountryIssuingCountryNameIssuingLocationLastUpdateDateLastUpdatedByPassportIdPassportNumberPassportTypePassportTypeMeaningProfessionpassportsDDFGET · POST · PATCH Person Passports Developer Descriptive FlexfieldsFields depend on your pod's flexfield setup (check
/describe).passportsDFFGET · POST · PATCH Person Passports Descriptive Flexfields · 3 fieldsPassportId__FLEX_Context__FLEX_Context_DisplayValuephonesGET · POST · PATCH · DELETE Phones · 18 fieldsAreaCodeCountryCodeNumberCreatedByCreationDateExtensionFromDateLastUpdateDateLastUpdatedByLegislationCodeLegislationNamePhoneIdPhoneNumberPhoneTypePhoneTypeMeaningPrimaryFlagToDateValidityValidityMeaningphonesDFFGET · POST · PATCH Person Phones Descriptive Flexfields · 3 fieldsPhoneId__FLEX_Context__FLEX_Context_DisplayValuereligionsGET · POST · PATCH · DELETE Religions · 10 fieldsCreatedByCreationDateLastUpdateDateLastUpdatedByLegislationCodeLegislationNamePrimaryFlagReligionReligionIdReligionMeaningreligionsDFFGET · POST · PATCH Person Religions Descriptive Flexfields · 3 fieldsReligionId__FLEX_Context__FLEX_Context_DisplayValuevisasPermitsGET · POST · PATCH · DELETE Visa Permits · 23 fields · 1 findersCreatedByCreationDateEffectiveEndDateEffectiveStartDateEntryDateExpirationDateIssueDateIssuingAuthorityIssuingCountryIssuingCountryNameIssuingLocationLastUpdateDateLastUpdatedByProfessionVisaPermitCategoryVisaPermitCategoryMeaningVisaPermitIdVisaPermitNumberVisaPermitStatusVisaPermitStatusDateVisaPermitStatusMeaningVisaPermitTypeVisaPermitTypeMeaningvisasPermitsDDFGET · POST · PATCH Person Visas and Permits Developer Descriptive FlexfieldsFields depend on your pod's flexfield setup (check
/describe).visasPermitsDFFGET · POST · PATCH Person Visas and Permits Descriptive Flexfields · 5 fieldsEffectiveEndDateEffectiveStartDateVisaPermitId__FLEX_Context__FLEX_Context_DisplayValue
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/hcmContactsand 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:BloodType, notbloodtype. - 7 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- 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.