Hub Organizations
hubOrganizations Based on latest (2026.09)
Create, change, delete and look up Hub Organizations, with additional identifier, additional name and address. Actions include find duplicates and normalize for duplicate search.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE15 actions
- Record key
PartyNumber- Required on create
AddressNumberCountryOrganizationNamePartyNumberUniqueNameAlias- At a glance
- 136 fields6 finders19 children1 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/hubOrganizations?fields=AccountScore,AccountScoringTier,Address1,Address2,Address3&limit=25&onlyData=true
{
"items": [
{
"AccountScore": 0,
"AccountScoringTier": "<string, max 30>",
"Address1": "<string, max 240>",
"Address2": "<string, max 240>",
"Address3": "<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 136
| Attribute | Type | Use |
|---|---|---|
AccountScore | number | Optional on createUpdatableSearchable |
AccountScoringTier | 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 |
AnalysisFiscalYear | text · max 5 | Optional on createUpdatableSearchable |
BankCode | text · max 30 | Optional on createUpdatableSearchable |
BankOrBranchNumber | text · max 30 | Optional on createUpdatableSearchable |
BranchCode | text · max 30 | Optional on createUpdatableSearchable |
BranchFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
Building | text · max 240 | Optional on createUpdatableSearchable |
BusinessReport | text | Optional on createUpdatable |
BusinessScope | text · max 20 | Optional on createUpdatableSearchable |
CEOName | text · max 240 | Optional on createUpdatableSearchable |
CEOTitle | 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 |
CongressionalDistrictCode | text · max 2 | Optional on createUpdatableSearchable |
ControlYear | number | Optional on createUpdatableSearchable |
CorpCurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
CorporationClass | text · max 60 | 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 |
CurrentFiscalYearPotentialRevenueAmount | number | Optional on createUpdatableSearchable |
DUNSCreditRating | text · max 5 | Optional on createUpdatableSearchable |
DUNSNumber | text · max 30 | Optional on createUpdatableSearchable |
DataCloudStatus | text · max 30 | Optional on createUpdatableSearchable |
DataConfidenceScore | number | Optional on createUpdatableSearchable |
DatafoxCompanyId | text · max 30 | Optional on createUpdatableSearchable |
Description | text · max 2000 | Optional on createUpdatableSearchable |
DisadvantageIndicator | text · max 30 | Optional on createUpdatableSearchable |
DisplayedDUNSPartyId | number | Optional on createUpdatableSearchable |
DoNotConfuseWith | text · max 255 | Optional on createUpdatableSearchable |
DomesticUltimateDUNSNumber | text · max 30 | Optional on createUpdatableSearchable |
DuplicateIndicator | text · max 30 | Optional on createUpdatableSearchable |
DuplicateScore | number | Optional on createUpdatableSearchable |
EmailAddress | text | Optional on createUpdatableSearchable |
EmailVerificationDate | date | Optional on createUpdatable |
EmailVerificationStatus | text · max 30 | Optional on createUpdatable |
EmployeesAtPrimaryAddress | text · max 10 | Optional on createUpdatableSearchable |
EmployeesAtPrimaryAddressEstimation | text · max 30 | Optional on createUpdatableSearchable |
EmployeesAtPrimaryAddressMinimum | text · max 30 | Optional on createUpdatableSearchable |
EmployeesAtPrimaryAddressText | text · max 12 | Optional on createUpdatableSearchable |
EmployeesTotal | number | Optional on createUpdatableSearchable |
EnquiryDUNS | text · max 15 | Optional on createUpdatableSearchable |
EnrichmentScore | number | Optional on createUpdatableSearchable |
ExportIndicator | text · max 30 | Optional on createUpdatableSearchable |
FiscalYearendMonth | text · max 30 | Optional on createUpdatableSearchable |
FloorNumber | text · max 40 | Optional on createUpdatableSearchable |
FormattedAddress | text | Read-only |
GeneralServicesAdministrationFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
GlobalUltimateDUNSNumber | text · max 30 | Optional on createUpdatableSearchable |
GrowthStrategyDescription | text · max 2000 | Optional on createUpdatableSearchable |
HQBranchIndicator | text · max 30 | Optional on createUpdatableSearchable |
HomeCountry | text · max 2 | Optional on createUpdatableSearchable |
ImportIndicator | text · max 30 | Optional on createUpdatableSearchable |
Keywords | text · max 2000 | Optional on createUpdatableSearchable |
LaborSurplusIndicator | text · max 30 | Optional on createUpdatableSearchable |
LastEnrichmentDate | date | Read-onlySearchable |
LastScoreUpdateDate | date-time | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
LegalStatus | text · max 30 | Optional on createUpdatableSearchable |
LineOfBusiness | text · max 240 | Optional on createUpdatableSearchable |
LocalActivityCode | text · max 30 | Optional on createUpdatableSearchable |
LocalActivityCodeType | text · max 30 | Optional on createUpdatableSearchable |
LocalBusinessIdentifier | text · max 60 | Optional on createUpdatableSearchable |
LocalBusinessIdentifierType | text · max 30 | Optional on createUpdatableSearchable |
Mailstop | text · max 60 | Optional on createUpdatableSearchable |
MinorityOwnedIndicator | text · max 30 | Optional on createUpdatableSearchable |
MinorityOwnedType | text · max 30 | Optional on createUpdatableSearchable |
MissionStatement | text · max 2000 | Optional on createUpdatableSearchable |
NextFiscalYearPotentialRevenueAmount | number | Optional on createUpdatableSearchable |
OrganizationName | text · max 360 | Required on createUpdatableSearchable |
OrganizationSize | text · max 30 | Optional on createUpdatableSearchable |
OrganizationType | text · max 30 | Optional on createUpdatableSearchable |
OutOfBusinessIndicator | text · max 30 | Optional on createUpdatableSearchable |
ParentDUNSNumber | text · max 30 | Optional on createUpdatableSearchable |
ParentOrSubsidiaryIndicator | text · max 30 | Optional on createUpdatableSearchable |
PartyId | number | Read-onlySearchable |
PartyNumber | text · max 30 | Required on createSearchable |
PartyUsageCode | text | Optional on createUpdatableSearchable |
PhoneVerificationDate | date | Optional on createUpdatable |
PhoneVerificationStatus | text · max 30 | Optional on createUpdatable |
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 |
PrincipalName | text · max 240 | Optional on createUpdatableSearchable |
PrincipalTitle | text · max 240 | Optional on createUpdatableSearchable |
Province | text · max 60 | Optional on createUpdatableSearchable |
PublicPrivateOwnershipFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
RawPhoneNumber | text | Optional on createUpdatableSearchable |
RecencyScore | number | Optional on createUpdatableSearchable |
RegistrationType | text · max 30 | Optional on createUpdatableSearchable |
RentOrOwnIndicator | text · max 30 | Optional on createUpdatableSearchable |
SmallBusinessIndicator | text · max 30 | 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 |
StockSymbol | text · max 20 | Optional on createUpdatableSearchable |
TaxpayerIdentificationNumber | text · max 20 | Optional on createUpdatableSearchable |
ThirdPartyFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
TotalEmployeesEstimatedIndicator | text · max 30 | Optional on createUpdatableSearchable |
TotalEmployeesIndicator | text · max 30 | Optional on createUpdatableSearchable |
TotalEmployeesMinimumIndicator | text · max 30 | Optional on createUpdatableSearchable |
TotalEmployeesText | text · max 60 | Optional on createUpdatableSearchable |
TotalPaymentAmount | number | Optional on createUpdatableSearchable |
TradingPartnerIdentifier | text · max 30 | Optional on createUpdatableSearchable |
URL | text | Optional on createUpdatableSearchable |
UniqueNameAlias | text · max 360 | Required on createUpdatableSearchable |
UniqueNameSuffix | text · max 540 | Optional on createUpdatableSearchable |
ValidatedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ValidityScore | number | Optional on createUpdatableSearchable |
WomanOwnedIndicator | text · max 30 | Optional on createUpdatableSearchable |
YearEstablished | number | Optional on createUpdatableSearchable |
YearIncorporated | number | Optional on createUpdatableSearchable |
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 19
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/hubOrganizations/{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 · 5 findersAddrElementAttribute1AddrElementAttribute2AddrElementAttribute3AddrElementAttribute4AddrElementAttribute5Address1Address2Address3Address4AddressIdAddressLinesPhoneticAddressNumberAddressTypeBuildingCalculateFormattedAddressCityClliCodeCommentsConflictIdCorpCurrencyCodeCountryCountyCreatedByCreatedByModuleCreatedByModule1CreationDateCurcyConvRateTypeCurrencyCodeDateValidatedDescriptionDoNotMailFlagDoNotValidateFlagDunsNumberCEffectiveDateEndDateActiveFloorNumberFormattedAddressFormattedAddress1FormattedMultilineAddressFormattedMultilineAddress1HouseTypeLastUpdateDateLastUpdateLoginLastUpdatedByLatitudeLocationDirectionsLocationIdLongitudeMailstopObjectVersionNumberObjectVersionNumber1PartyIdPartyNamePartyNumberPartySiteNamePartySourceSystemPartySourceSystemReferenceValuePartyUniqueNamePostalCodePostalPlus4CodePrimaryFlagProvinceSSROwnerTableNameSSRPartyOwnerTableNameSalesAccountFlagSourceSystemSourceSystemReferenceValueStartDateActiveStateStatusValidatedFlagValidationStartDateValidationStatusCodeAddressLocaleGET · POST · PATCH · DELETE Address Locales · 30 fieldsAddrElementAttribute1AddrElementAttribute2AddrElementAttribute3AddrElementAttribute4AddrElementAttribute5Address1Address2Address3Address4AddressNumberBuildingCityCountryCountyCreatedByCreationDateFloorNumberFormattedAddressLastUpdateDateLastUpdateLoginLastUpdatedByLocationIdLocationLocaleIdPostalCodePostalPlus4codeProvinceSiteSourceSystemSiteSourceSystemReferenceValueStateTransliterationLanguageAddressPurposeGET · POST · PATCH · DELETE Address Purposes · 20 fields · 1 findersAddressIdAddressNumberAddressPurposeIdCommentsCreatedByCreatedByModuleCreationDateDeleteFlagEndDateLastUpdateDateLastUpdateLoginLastUpdatedByPrimaryPerTypePurposeSiteSourceSystemSiteSourceSystemReferenceValueSourceSystemSourceSystemReferenceValueStartDateStatusAttachmentGET · POST · PATCH · DELETE Organization Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameContactPointGET · POST · PATCH · DELETE Contact Points · 39 fieldsConflictIdContactPointIdContactPointTypeCreatedByCreatedByModuleCreationDateDoContactPreferenceFlagDoNotContactPreferenceFlagDoNotContactReasonEmailAddressEmailPurposeFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValuePhoneAreaCodePhoneCountryCodePhoneExtensionPhoneNumberPhonePurposePhoneTypePreferenceRequestedByPrimaryFlagRawPhoneNumberSocialNetworkIdSocialNetworkNameSocialNetworkPurposeSourceSystemSourceSystemReferenceValueStatusURLVerificationDateVerificationStatusWebPurposeCustomerClassificationGET · POST · PATCH · DELETE Customer Classifications · 25 fields · 1 findersClassCategoryClassCodeClassCodeMeaningCodeAssignmentIdConflictIdCreatedByCreatedByModuleCreationDateEndDateActiveIsAuxClassificationFlagIsIndustryFlagIsOrgTypeFlagLastUpdateDateLastUpdateLoginLastUpdatedByPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValuePartyTypePrimaryFlagSourceSystemSourceSystemReferenceValueStartDateActiveStatusDuplicatePartyGET · POST · PATCH · DELETE Duplicate Parties · 9 fields · 1 findersCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByPartyIdPartyNamePartyNumberPromotedFlagLinkedPartyGET · POST · PATCH · DELETE Linked Parties · 16 fields · 2 findersCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByLinkIdLinkNumberLinkTypeMainLinkObjectCodePartyIdPartyNamePartyNumberPartyTypeRelatedPartyIdRelatedPartyNumberNoteGET · POST · PATCH · DELETE Notes · 27 fieldsContactRelationshipIdCorpCurrencyCodeCreatedByCreationDateCreatorPartyIdCurcyConvRateTypeCurrencyCodeDeleteFlagEmailAddressFormattedAddressFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByNoteIdNoteNumberNoteTitleNoteTxtNoteTypeCodeParentNoteIdPartyIdPartyNameSourceObjectCodeSourceObjectIdSourceSystemUpdateFlagVisibilityCodeOrganizationInformationGET Organization Dynamic Flexfields · 3 fieldsOrganizationProfileId__FLEX_Context__FLEX_Context_DisplayValueRelationshipGET · POST · PATCH · DELETE Relationships · 56 fields · 11 findersBackwardRoleBackwardRoleDescriptionCommentsConflictIdCreatedByCreatedByModuleCreationDateDependentFlagDirectionCodeEndDateHeadOfHouseholdFlagInfluenceLevelIsObjectSalesPartyFlagIsSubjectSalesPartyFlagJobDefinitionNameJobDefinitionPackageLastUpdateDateLastUpdateLoginLastUpdatedByObjectPartyIdObjectPartyNameObjectPartyNumberObjectSourceSystemObjectSourceSystemReferenceValueObjectTableNameObjectTypeObjectUsageCodeObjectVersionNumberObjectVersionNumber1ObjectVersionNumber2PartyIdPartyId1PercentageOwnershipPreferredContactFlagPrimaryCustomerFlagRelationshipCodeRelationshipGroupRelationshipIdRelationshipRecIdRelationshipSourceSystemRelationshipSourceSystemReferenceValueRelationshipTypeRequestIdRoleRoleDescriptionSSROwnerTableNameStartDateStatusSubjectPartyIdSubjectPartyNameSubjectPartyNumberSubjectSourceSystemSubjectSourceSystemReferenceValueSubjectTableNameSubjectTypeSubjectUsageCodeSourceSystemReferenceGET · POST · PATCH · DELETE Source System References · 18 fieldsConflictIdCreatedByCreatedByModuleCreationDateEndDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValueSourceSystemSourceSystemReferenceIdSourceSystemReferenceValueStartDateStatusUsageAssignmentGET · POST · PATCH · DELETE Party Usage Assignments · 12 fieldsCommentsCreatedByCreatedByModuleCreationDateEndDateLastUpdateDateLastUpdatedByPartyIdPartyUsageAssignmentIdPartyUsageCodeStartDateStatusFlagsmartActionsGET Smart Actions · 17 fields · 5 findersActionIntentConfirmationMessageContentTypeDisplayLabelEntityHrefIncludedInApplicationMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserActionNavigationGET Smart Action User Interface Definitions · 5 fields · 1 findersSystemActionFlagUserActionNavAppUsageUserActionNavBodyUserActionNavIdUserActionNavTypeUserActionRequestPayloadGET Smart Action REST Payload Definitions · 8 fields · 1 findersBindingMandatoryFlagRequestPayloadIdRequestPayloadNameSmartSuggestPathSystemActionFlagValueValueStructUserActionURLBindingGET Smart Action User Interface Definitions · 5 fields · 1 findersBindingSystemActionFlagURLBindingIdURLBindingNameValue
Actions 15
POST …/action/findDuplicates·hubOrganizationPOST …/action/normalizeForDuplicateSearch·hubOrganizationPOST …/action/promoteDuplicateParty·PartyNumberPartyIdPOST …/{PartyNumber}/child/Address/{AddressNumber}/action/PartySiteEO_setCurrentOverallPrimaryFlagPOST …/{PartyNumber}/child/Address/{AddressNumber}/action/PartySiteEO_setCurrentPrimaryFlagPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/action/RelationshipEO_setPreferredContactIdPOST …/{PartyNumber}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/smartActions/{UserActionId}/action/executeAction
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/hubOrganizationsand 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:AccountScore, notaccountscore. - 8 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.