Hub Persons
hubPersons Based on latest (2026.09)
Create, change, delete and look up Hub Persons, with additional identifier, additional name and address. Actions include find duplicates.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE4 actions
- Record key
PartyNumber- Required on create
AddressNumberCountryPartyNumber- At a glance
- 113 fields6 finders10 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/hubPersons?fields=AcademicTitle,Address1,Address2,Address3,Address4&limit=25&onlyData=true
{
"items": [
{
"AcademicTitle": "<string, max 30>",
"Address1": "<string, max 240>",
"Address2": "<string, max 240>",
"Address3": "<string, max 240>",
"Address4": "<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 113
| Attribute | Type | Use |
|---|---|---|
AcademicTitle | text · max 30 | Optional on createUpdatableSearchable |
Address1 | text · max 240 | Optional on createUpdatableSearchable |
Address2 | text · max 240 | Optional on createUpdatableSearchable |
Address3 | text · max 240 | Optional on createUpdatableSearchable |
Address4 | text · max 240 | Optional on createUpdatableSearchable |
AddressElementAttribute1 | text · max 150 | Optional on createUpdatableSearchable |
AddressElementAttribute2 | text · max 150 | Optional on createUpdatableSearchable |
AddressElementAttribute3 | text · max 150 | Optional on createUpdatableSearchable |
AddressElementAttribute4 | text · max 150 | Optional on createUpdatableSearchable |
AddressElementAttribute5 | text · max 150 | Optional on createUpdatableSearchable |
AddressLinesPhonetic | text · max 560 | Optional on createUpdatableSearchable |
AddressNumber | text · max 30 | Required on createUpdatableSearchable |
AddressType | text | Optional on createUpdatableSearchable |
Building | text · max 240 | Optional on createUpdatableSearchable |
CertificationLevel | text · max 30 | Optional on createUpdatableSearchable |
CertificationReasonCode | text · max 30 | Optional on createUpdatableSearchable |
City | text · max 60 | Optional on createUpdatableSearchable |
CleanlinessScore | number | Optional on createUpdatableSearchable |
Comments | text · max 2000 | Optional on createUpdatableSearchable |
CompletenessScore | number | Optional on createUpdatableSearchable |
ContactRole | text · max 60 | Optional on createUpdatableSearchable |
CorpCurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
Country | text · max 2 | Required on createUpdatableSearchable |
County | text · max 60 | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreatedByModule | text · max 30 · default ORA_ZCH_WS | Optional on createSearchable |
CreationDate | date-time | Read-onlySearchable |
CurcyConvRateType | text · max 30 | Optional on createUpdatableSearchable |
CurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
DataCloudStatus | text · max 30 | Optional on createUpdatableSearchable |
DataConfidenceScore | number | Optional on createUpdatableSearchable |
DateOfBirth | date | Optional on createUpdatableSearchable |
DateOfDeath | date | Optional on createUpdatableSearchable |
DeceasedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
DeclaredEthnicity | text · max 60 | Optional on createUpdatableSearchable |
Department | text · max 60 | Optional on createUpdatableSearchable |
DepartmentCode | text · max 30 | Optional on createUpdatableSearchable |
DoNotCallFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
DoNotContactFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
DoNotEmailFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
DoNotMailFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
DuplicateIndicator | text · max 30 | Optional on createUpdatableSearchable |
DuplicateScore | number | Optional on createUpdatableSearchable |
EmailAddress | text · max 320 | Optional on createUpdatableSearchable |
EmailVerificationDate | date | Optional on createUpdatable |
EmailVerificationStatus | text · max 30 | Optional on createUpdatable |
EnrichmentScore | number | Optional on createUpdatableSearchable |
FirstName | text · max 150 | Optional on createUpdatableSearchable |
FloorNumber | text · max 40 | Optional on createUpdatableSearchable |
Gender | text · max 30 | Optional on createUpdatableSearchable |
HeadOfHouseholdFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
HomePhoneVerificationDate | date | Optional on createUpdatable |
HomePhoneVerificationStatus | text · max 30 | Optional on createUpdatable |
HouseholdIncomeAmount | number | Optional on createUpdatableSearchable |
HouseholdSize | number | Optional on createUpdatableSearchable |
Initials | text · max 20 | Optional on createUpdatableSearchable |
JobTitle | text · max 100 | Optional on createUpdatableSearchable |
JobTitleCode | text · max 30 | Optional on createUpdatableSearchable |
LastContactDate | date-time | Optional on createUpdatableSearchable |
LastEnrichmentDate | date | Optional on createUpdatableSearchable |
LastName | text · max 150 | Optional on createUpdatableSearchable |
LastNamePrefix | text · max 30 | Optional on createUpdatableSearchable |
LastScoreUpdateDate | date-time | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
Mailstop | text · max 60 | Optional on createUpdatableSearchable |
MaritalStatus | text · max 30 | Optional on createUpdatableSearchable |
MaritalStatusEffectiveDate | date | Optional on createUpdatableSearchable |
MiddleName | text · max 60 | Optional on createUpdatableSearchable |
MobilePhoneVerificationDate | date | Optional on createUpdatable |
MobilePhoneVerificationStatus | text · max 30 | Optional on createUpdatable |
NameSuffix | text · max 30 | Optional on createUpdatableSearchable |
OrganizationPartyId | number | Optional on createUpdatableSearchable |
OrganizationPartyName | text · max 360 | Read-onlySearchable |
OrganizationPartyNumber | text · max 30 | Read-onlySearchable |
OrganizationSourceSystem | text | Optional on createUpdatableSearchable |
OrganizationSourceSystemReferenceValue | text | Optional on createUpdatableSearchable |
PartyId | number | Read-onlySearchable |
PartyNumber | text · max 30 | Required on createSearchable |
PartyUsageCode | text | Optional on createUpdatableSearchable |
PersonName | text · max 450 | Read-onlySearchable |
PersonalIncomeAmount | number | Optional on createUpdatableSearchable |
PlaceOfBirth | text · max 60 | Optional on createUpdatableSearchable |
PostalCode | text · max 60 | Optional on createUpdatableSearchable |
PostalPlus4Code | text · max 20 | Optional on createUpdatableSearchable |
PreferredContactMethod | text · max 30 | Optional on createUpdatableSearchable |
PreferredFunctionalCurrency | text · max 15 | Optional on createUpdatableSearchable |
PreviousLastName | text · max 150 | Optional on createUpdatableSearchable |
Province | text · max 60 | Optional on createUpdatableSearchable |
RawHomePhoneNumber | text · max 60 | Optional on createUpdatableSearchable |
RawMobilePhoneNumber | text · max 60 | Optional on createUpdatableSearchable |
RawWorkPhoneNumber | text · max 60 | Optional on createUpdatableSearchable |
RecencyScore | number | Optional on createUpdatableSearchable |
RegistrationStatus | text · max 30 | Optional on createUpdatableSearchable |
RentOrOwnIndicator | text · max 30 | Optional on createUpdatableSearchable |
SalesAffinityCode | text · max 30 | Optional on createUpdatableSearchable |
SalesBuyingRoleCode | text · max 30 | Optional on createUpdatableSearchable |
Salutation | text · max 60 | Optional on createUpdatableSearchable |
SalutoryIntroduction | text · max 30 | Optional on createUpdatableSearchable |
SecondLastName | text · max 150 | Optional on createUpdatableSearchable |
SourceSystem | text · max 255 | Optional on createUpdatableSearchable |
SourceSystemReferenceValue | text · max 255 | Optional on createUpdatableSearchable |
State | text · max 60 | Optional on createUpdatableSearchable |
Status | text · max 1 · default A | Read-onlySearchable |
TaxpayerIdentificationNumber | text · max 20 | Optional on createUpdatableSearchable |
ThirdPartyFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
TimezoneCode | text · max 64 | Optional on createUpdatableSearchable |
Title | text · max 60 | Optional on createUpdatableSearchable |
UniqueNameSuffix | text · max 540 | Optional on createUpdatableSearchable |
ValidatedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ValidityScore | number | Optional on createUpdatableSearchable |
WorkPhoneVerificationDate | date | Optional on createUpdatable |
WorkPhoneVerificationStatus | 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 6
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
PartyIdAltKey·PartyIdPartyNumberAltKey·PartyNumberPartyNumberRF·PartyNumberPartyUsageCodeRF·PartyUsageCodeSourceSystemReferenceAltKey·SourceSystemSourceSystemReferenceValueSourceSystemReferenceRF·SourceSystemSourceSystemReferenceValue
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: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/<name>. Add them to a GET with expand.
AdditionalIdentifierGET · POST · PATCH · DELETE Additional Identifiers · 24 fieldsCountryCreatedByCreatedByModuleCreationDateDescriptionExpirationDateIssueDateIssuingAuthorityNameIssuingAuthorityPartyIdLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPartyIdPartyIdentifierIdPartyIdentifierTypePartyIdentifierValuePartyNumberPartySourceSystemPartySourceSystemReferenceValueSourceSystemSourceSystemReferenceValueStateProvinceStatusCodeAdditionalNameGET · POST · PATCH · DELETE Additional Names · 23 fields · 2 findersAcademicTitleConflictIdCreatedByCreationDateDescriptionFirstNameLastNameLastUpdateDateLastUpdatedByMiddleNameNameNameIdNameTypePartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValuePreferredFlagSourceSystemSourceSystemReferenceValueStatusFlagTitleTransliterationLanguageAddressGET · POST · PATCH · DELETE Addresses · 73 fields · 4 findersAddrElementAttribute1AddrElementAttribute2AddrElementAttribute3AddrElementAttribute4AddrElementAttribute5Address1Address2Address3Address4AddressIdAddressLinesPhoneticAddressNumberAddressTypeBuildingCalculateFormattedAddressCityClliCodeCommentsConflictIdCorpCurrencyCodeCountryCountyCreatedByCreatedByModuleCreatedByModule1CreationDateCurcyConvRateTypeCurrencyCodeDateValidatedDescriptionDoNotMailFlagDoNotValidateFlagDunsNumberCEffectiveDateEndDateActiveFloorNumberFormattedAddressFormattedAddress1FormattedMultilineAddressFormattedMultilineAddress1HouseTypeLastUpdateDateLastUpdateLoginLastUpdatedByLatitudeLocationDirectionsLocationIdLongitudeMailstopObjectVersionNumberObjectVersionNumber1PartyIdPartyNamePartyNumberPartySiteNamePartySourceSystemPartySourceSystemReferenceValuePartyUniqueNamePostalCodePostalPlus4CodePrimaryFlagProvinceSSROwnerTableNameSSRPartyOwnerTableNameSalesAccountFlagSourceSystemSourceSystemReferenceValueStartDateActiveStateStatusValidatedFlagValidationStartDateValidationStatusCodeAttachmentGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameContactPointGET · POST · PATCH · DELETE Contact Points · 39 fieldsConflictIdContactPointIdContactPointTypeCreatedByCreatedByModuleCreationDateDoContactPreferenceFlagDoNotContactPreferenceFlagDoNotContactReasonEmailAddressEmailPurposeFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValuePhoneAreaCodePhoneCountryCodePhoneExtensionPhoneNumberPhonePurposePhoneTypePreferenceRequestedByPrimaryFlagRawPhoneNumberSocialNetworkIdSocialNetworkNameSocialNetworkPurposeSourceSystemSourceSystemReferenceValueStatusURLVerificationDateVerificationStatusWebPurposeCustomerClassificationGET · POST · PATCH · DELETE Customer Classifications · 25 fields · 1 findersClassCategoryClassCodeClassCodeMeaningCodeAssignmentIdConflictIdCreatedByCreatedByModuleCreationDateEndDateActiveIsAuxClassificationFlagIsIndustryFlagIsOrgTypeFlagLastUpdateDateLastUpdateLoginLastUpdatedByPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValuePartyTypePrimaryFlagSourceSystemSourceSystemReferenceValueStartDateActiveStatusNoteGET · POST · PATCH · DELETE Notes · 27 fieldsContactRelationshipIdCorpCurrencyCodeCreatedByCreationDateCreatorPartyIdCurcyConvRateTypeCurrencyCodeDeleteFlagEmailAddressFormattedAddressFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByNoteIdNoteNumberNoteTitleNoteTxtNoteTypeCodeParentNoteIdPartyIdPartyNameSourceObjectCodeSourceObjectIdSourceSystemUpdateFlagVisibilityCodeRelationshipGET · POST · PATCH · DELETE Relationships · 56 fields · 9 findersBackwardRoleBackwardRoleDescriptionCommentsConflictIdCreatedByCreatedByModuleCreationDateDependentFlagDirectionCodeEndDateHeadOfHouseholdFlagInfluenceLevelIsObjectSalesPartyFlagIsSubjectSalesPartyFlagJobDefinitionNameJobDefinitionPackageLastUpdateDateLastUpdateLoginLastUpdatedByObjectPartyIdObjectPartyNameObjectPartyNumberObjectSourceSystemObjectSourceSystemReferenceValueObjectTableNameObjectTypeObjectUsageCodeObjectVersionNumberObjectVersionNumber1ObjectVersionNumber2PartyIdPartyId1PercentageOwnershipPreferredContactFlagPrimaryCustomerFlagRelationshipCodeRelationshipGroupRelationshipIdRelationshipRecIdRelationshipSourceSystemRelationshipSourceSystemReferenceValueRelationshipTypeRequestIdRoleRoleDescriptionSSROwnerTableNameStartDateStatusSubjectPartyIdSubjectPartyNameSubjectPartyNumberSubjectSourceSystemSubjectSourceSystemReferenceValueSubjectTableNameSubjectTypeSubjectUsageCodeSourceSystemReferenceGET · POST · PATCH · DELETE Source System References · 18 fieldsConflictIdCreatedByCreatedByModuleCreationDateEndDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValueSourceSystemSourceSystemReferenceIdSourceSystemReferenceValueStartDateStatusUsageAssignmentGET · POST · PATCH · DELETE Usage Assignments · 12 fieldsCommentsCreatedByCreatedByModuleCreationDateEndDateLastUpdateDateLastUpdatedByPartyIdPartyUsageAssignmentIdPartyUsageCodeStartDateStatusFlag
Actions 4
POST …/action/findDuplicates·organizationPartyNumberhubPersonPOST …/{PartyNumber}/child/Address/{AddressNumber}/action/PartySiteEO_setCurrentOverallPrimaryFlagPOST …/{PartyNumber}/child/Address/{AddressNumber}/action/PartySiteEO_setCurrentPrimaryFlagPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/action/RelationshipEO_setPreferredContactId
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/hubPersonsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
PartyIdAltKeyfor 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:AcademicTitle, notacademictitle. - 9 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.