Households
households Based on latest (2026.09)
Create, change, delete and look up Households, with additional identifier, additional name and address.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE84 actions
- Record key
PartyNumber- Required on create
AddressNumberCountryEffectiveSequenceEmailAddressHouseholdNamePartyNumberPartyNumberKey- At a glance
- 119 fields5 finders51 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/households?fields=AddressElementAttribute1,AddressElementAttribute2,AddressElementAttribute3,AddressElementAttribute4,AddressElementAttribute5&limit=25&onlyData=true
{
"items": [
{
"AddressElementAttribute1": "<string, max 150>",
"AddressElementAttribute2": "<string, max 150>",
"AddressElementAttribute3": "<string, max 150>",
"AddressElementAttribute4": "<string, max 150>",
"AddressElementAttribute5": "<string, max 150>"
}
],
"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 119
| Attribute | Type | Use |
|---|---|---|
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 |
AddressLine1 | text · max 240 | Optional on createUpdatableSearchable |
AddressLine2 | text · max 240 | Optional on createUpdatableSearchable |
AddressLine3 | text · max 240 | Optional on createUpdatableSearchable |
AddressLine4 | text · max 240 | Optional on createUpdatableSearchable |
AddressLinesPhonetic | text · max 560 | Optional on createUpdatableSearchable |
AddressNumber | text · max 30 | Required on createSearchable |
AddressType | text | Optional on createUpdatable |
AnnualIncome | number | Optional on createUpdatableSearchable |
AssignmentExceptionFlag | yes/no · max 1 · default false | Read-only |
AverageAge | number | Optional on createUpdatableSearchable |
Building | text · max 240 | Optional on createUpdatableSearchable |
CertificationLevel | text · max 30 | Optional on createUpdatableSearchable |
CertificationReasonCode | text · max 30 | Optional on createUpdatableSearchable |
Child0to6Number | number | Optional on createUpdatableSearchable |
Child13to18Number | number | Optional on createUpdatableSearchable |
Child7to12Number | number | Optional on createUpdatableSearchable |
City | text · max 60 | Optional on createUpdatableSearchable |
ClassificationCategory | text | Optional on createUpdatable |
ClassificationCode | text | Optional on createUpdatable |
Comments | text · max 2000 | Optional on createUpdatableSearchable |
ConflictId | number · default 0 | 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 · default HZ_WS | Optional on createUpdatable |
CreatedByModule1 | text · max 30 | Optional on createUpdatableSearchable |
CreationDate | date-time | Read-onlySearchable |
CurcyConvRateType | text · max 30 | Optional on createUpdatableSearchable |
CurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
DeleteFlag | yes/no | Read-only |
DependentsNumber | number | Optional on createUpdatableSearchable |
EffectiveLatestChange | text · max 1 · default Y | Optional on createUpdatableSearchable |
EffectiveSequence | number | Required on createUpdatableSearchable |
EmailAddress | text · max 320 | Required on createUpdatableSearchable |
EmailContactPointId | number | Read-onlySearchable |
EmailContactPointType | text · max 30 · default EMAIL | Read-onlySearchable |
EmailFormat | text · max 30 | Optional on createUpdatableSearchable |
EmailVerificationDate | date | Optional on createUpdatable |
EmailVerificationStatus | text · max 30 | Optional on createUpdatable |
ExistingCustomerFlag | yes/no · max 1 · default false | Read-only |
ExistingCustomerFlagLastUpdateDate | date | Read-only |
FavoriteHouseholdFlag | yes/no · max 10 · default false | Optional on createUpdatableSearchable |
FloorNumber | text · max 40 | Optional on createUpdatableSearchable |
FormattedAddress | text | Read-only |
FormattedPhoneNumber | text | Read-only |
GroupPartyId | number | Optional on createUpdatableSearchable |
GroupType | text · max 30 · default HOUSEHOLD | Read-onlySearchable |
HouseholdName | text · max 360 | Required on createUpdatableSearchable |
HouseholdProfileId | number | Optional on createSearchable |
HouseholdSize | number | Optional on createUpdatableSearchable |
LastAssignmentDate | date | Read-onlySearchable |
LastAssignmentDateTime | date-time | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
Mailstop | text · max 60 | Optional on createUpdatableSearchable |
MedianAge | number | Optional on createUpdatableSearchable |
NamedFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
ObjectVersionNumberEmail | number | Optional on createUpdatableSearchable |
ObjectVersionNumberGroup | number | Optional on createUpdatableSearchable |
ObjectVersionNumberOwner | number | Read-onlySearchable |
ObjectVersionNumberParty | number | Optional on createUpdatableSearchable |
ObjectVersionNumberPhone | number | Optional on createUpdatableSearchable |
ObjectVersionNumberSalesAccount | number | Optional on createUpdatableSearchable |
OwnerEmailAddress | text · max 320 | Read-onlySearchable |
OwnerName | text · max 360 | Read-onlySearchable |
OwnerPartyId | number | Optional on createUpdatableSearchable |
OwnerPartyId1 | number | Read-onlySearchable |
OwnerPartyNumber | text · max 30 | Read-onlySearchable |
PartyId | number | Read-onlySearchable |
PartyNumber | text · max 30 | Required on createSearchable |
PartyNumberKey | text · max 30 | Required on createUpdatableSearchable |
PartyStatus | text · max 1 · default A | Read-onlySearchable |
PartyType | text · max 30 · default GROUP | Read-onlySearchable |
PartyUniqueName | text · max 900 | Read-onlySearchable |
PhoneAreaCode | text · max 20 | Optional on createUpdatableSearchable |
PhoneContactPointId | number | Read-onlySearchable |
PhoneContactPointType | text · max 30 · default PHONE | Read-onlySearchable |
PhoneCountryCode | text · max 10 | Optional on createUpdatableSearchable |
PhoneExtension | text · max 20 | Optional on createUpdatableSearchable |
PhoneNumber | text · max 40 | 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 |
PrimaryAddressId | number | Read-onlySearchable |
PrimaryContactEmail | text | Read-only |
PrimaryContactName | text · max 255 | Read-only |
PrimaryContactPartyId | number | Optional on createUpdatableSearchable |
PrimaryContactPartyNumber | text | Optional on createUpdatableSearchable |
PrimaryContactPhone | text | Read-only |
PrimaryContactRole | text | Optional on create |
PrimaryContactSourceSystem | text | Optional on createUpdatableSearchable |
PrimaryContactSourceSystemReferenceValue | text | Optional on createUpdatableSearchable |
Province | text · max 60 | Optional on createUpdatableSearchable |
RawPhoneNumber | text · max 60 | Optional on createUpdatableSearchable |
RecordSet | text · max 30 | Read-onlySearchable |
SSROwnerTableName | text · max 30 · default HZ_PARTIES | Read-only |
SalesProfileId | number | Optional on createSearchable |
SalesProfileNumber | text · max 30 | Optional on createUpdatableSearchable |
SalesProfileStatus | text · max 30 | Optional on createUpdatableSearchable |
SellToPartySiteId | number | Read-onlySearchable |
SourceObjectType | text · max 255 · default SALES_PARTY | Read-only |
SourceSystem | text | Optional on createUpdatableSearchable |
SourceSystemReferenceValue | text | Optional on createUpdatableSearchable |
State | text · max 60 | Optional on createUpdatableSearchable |
StringPartyId | text · max 255 | Read-only |
Type | text · max 30 | Optional on createUpdatableSearchable |
UniqueNameSuffix | text · max 540 | Optional on createUpdatableSearchable |
UpdateFlag | yes/no | Read-only |
WealthAmount | 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 5
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
HouseholdPartyNumberRF·PartyNumberMyHouseholds·BindUserPartyIdPartyIdAltKey·PartyIdPartyNumberAltKey·PartyNumberSourceSystemReferenceAltKey·SourceSystemSourceSystemReferenceValue
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 51
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/<name>. Add them to a GET with expand.
AdditionalIdentifierGET · POST · PATCH · DELETE Additional Identifiers · 24 fieldsCountryCreatedByCreatedByModuleCreationDateDescriptionExpirationDateIssueDateIssuingAuthorityNameIssuingAuthorityPartyIdLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPartyIdPartyIdentifierIdPartyIdentifierTypePartyIdentifierValuePartyNumberPartySourceSystemPartySourceSystemReferenceValueSourceSystemSourceSystemReferenceValueStateProvinceStatusCodesmartActionsGET 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 findersBindingSystemActionFlagURLBindingIdURLBindingNameValueAdditionalNameGET · POST · PATCH · DELETE Additional Names · 23 fields · 6 findersAcademicTitleConflictIdCreatedByCreationDateDescriptionFirstNameLastNameLastUpdateDateLastUpdatedByMiddleNameNameNameIdNameTypePartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValuePreferredFlagSourceSystemSourceSystemReferenceValueStatusFlagTitleTransliterationLanguagesmartActionsGET 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 findersBindingSystemActionFlagURLBindingIdURLBindingNameValueAddressGET · POST · PATCH · DELETE Addresses · 73 fields · 4 findersAddrElementAttribute1AddrElementAttribute2AddrElementAttribute3AddrElementAttribute4AddrElementAttribute5Address1Address2Address3Address4AddressIdAddressLinesPhoneticAddressNumberAddressTypeBuildingCalculateFormattedAddressCityClliCodeCommentsConflictIdCorpCurrencyCodeCountryCountyCreatedByCreatedByModuleCreatedByModule1CreationDateCurcyConvRateTypeCurrencyCodeDateValidatedDescriptionDoNotMailFlagDoNotValidateFlagDunsNumberCEffectiveDateEndDateActiveFloorNumberFormattedAddressFormattedAddress1FormattedMultilineAddressFormattedMultilineAddress1HouseTypeLastUpdateDateLastUpdateLoginLastUpdatedByLatitudeLocationDirectionsLocationIdLongitudeMailstopObjectVersionNumberObjectVersionNumber1PartyIdPartyNamePartyNumberPartySiteNamePartySourceSystemPartySourceSystemReferenceValuePartyUniqueNamePostalCodePostalPlus4CodePrimaryFlagProvinceSSROwnerTableNameSSRPartyOwnerTableNameSalesAccountFlagSourceSystemSourceSystemReferenceValueStartDateActiveStateStatusValidatedFlagValidationStartDateValidationStatusCodeAddressLocaleGET · POST · PATCH · DELETE Address Locales · 30 fields · 1 findersAddrElementAttribute1AddrElementAttribute2AddrElementAttribute3AddrElementAttribute4AddrElementAttribute5Address1Address2Address3Address4AddressNumberBuildingCityCountryCountyCreatedByCreationDateFloorNumberFormattedAddressLastUpdateDateLastUpdateLoginLastUpdatedByLocationIdLocationLocaleIdPostalCodePostalPlus4codeProvinceSiteSourceSystemSiteSourceSystemReferenceValueStateTransliterationLanguageAddressPurposeGET · POST · PATCH · DELETE Address Purposes · 20 fields · 1 findersAddressIdAddressNumberAddressPurposeIdCommentsCreatedByCreatedByModuleCreationDateDeleteFlagEndDateLastUpdateDateLastUpdateLoginLastUpdatedByPrimaryPerTypePurposeSiteSourceSystemSiteSourceSystemReferenceValueSourceSystemSourceSystemReferenceValueStartDateStatussmartActionsGET 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 findersBindingSystemActionFlagURLBindingIdURLBindingNameValueAttachmentGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameContactPointGET · POST · PATCH · DELETE Contact Points · 39 fieldsConflictIdContactPointIdContactPointTypeCreatedByCreatedByModuleCreationDateDoContactPreferenceFlagDoNotContactPreferenceFlagDoNotContactReasonEmailAddressEmailPurposeFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValuePhoneAreaCodePhoneCountryCodePhoneExtensionPhoneNumberPhonePurposePhoneTypePreferenceRequestedByPrimaryFlagRawPhoneNumberSocialNetworkIdSocialNetworkNameSocialNetworkPurposeSourceSystemSourceSystemReferenceValueStatusURLVerificationDateVerificationStatusWebPurposesmartActionsGET 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 findersBindingSystemActionFlagURLBindingIdURLBindingNameValueCustomerClassificationGET · POST · PATCH · DELETE Aux Classifications · 25 fieldsClassCategoryClassCodeClassCodeMeaningCodeAssignmentIdConflictIdCreatedByCreatedByModuleCreationDateEndDateActiveIsAuxClassificationFlagIsIndustryFlagIsOrgTypeFlagLastUpdateDateLastUpdateLoginLastUpdatedByPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValuePartyTypePrimaryFlagSourceSystemSourceSystemReferenceValueStartDateActiveStatusHouseholdContactGET · POST · PATCH · DELETE Household Contact · 51 fields · 1 findersContactFirstNameContactLastNameContactLastUpdateDateContactMiddleNameContactNameContactPartyIdContactPartyNumberContactSourceSystemContactSourceSystemReferenceValueCreatedByCreatedByModuleCreationDateDateOfBirthDoCallFlagDoEmailFlagDoNotCallFlagDoNotEmailFlagEmailAddressEmailVerificationDateEmailVerificationStatusEndDateFormattedAddressFormattedPhoneNumberGenderHeadOfHouseholdFlagHouseholdIncomeHouseholdPartyIdHouseholdPartyNameHouseholdPartyNumberHouseholdSizeHouseholdSourceSystemHouseholdSourceSystemReferenceValueHouseholdUniqueNameJobTitleLastUpdateDateLastUpdateLoginLastUpdatedByMaritalStatusPhoneVerificationDatePhoneVerificationStatusPreferredContactFlagPreferredContactMethodRelationshipCodeRelationshipIdRelationshipRecIdRelationshipSourceSystemRelationshipSourceSystemReferenceValueRelationshipTypeRoleSalutationStartDatesmartActionsGET 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 findersBindingSystemActionFlagURLBindingIdURLBindingNameValueHouseholdTeamGET Household Teams · 39 fieldsAccessLevelCodeAccountTeamIdAddedOnDateTimeAssignmentTypeCodeCityCorpCurrencyCodeCountryCreatedByCreationDateCurcyConvRateTypeCurrencyCodeEndDateActiveForecastParticipationCodeFunctionCodeLastUpdateDateLastUpdateLoginLastUpdatedByLockAssignmentFlagMemberFunctionCodeObjectVersionNumberOwnerFlagPartyIdPrimaryPhoneNumberResourceEmailAddressResourceIdResourceNameResourcePartyNumberResourceRoleNameSalesProfileIdStartDateActiveStateTeamMemberIdTerritoryFunctionCodeTerritoryNameTerritoryNumberTerritoryOwnerFlagTerritoryVersionIdTypeCodeUserLastUpdateDateNoteGET · POST · PATCH · DELETE Notes · 27 fieldsContactRelationshipIdCorpCurrencyCodeCreatedByCreationDateCreatorPartyIdCurcyConvRateTypeCurrencyCodeDeleteFlagEmailAddressFormattedAddressFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByNoteIdNoteNumberNoteTitleNoteTxtNoteTypeCodeParentNoteIdPartyIdPartyNameSourceObjectCodeSourceObjectIdSourceSystemUpdateFlagVisibilityCodesmartActionsGET 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 findersBindingSystemActionFlagURLBindingIdURLBindingNameValuePrimaryAddressGET · POST · PATCH · DELETE Primary Addresses · 65 fields · 1 findersAddressElementAttribute1AddressElementAttribute2AddressElementAttribute3AddressElementAttribute4AddressElementAttribute5AddressIdAddressLine1AddressLine2AddressLine3AddressLine4AddressLinesPhoneticAddressNumberAddresseeBuildingCityCommentsConflictIdCorpCurrencyCodeCountryCountyCreatedByCreationDateCurcyConvRateTypeCurrencyCodeDateValidatedDeleteFlagDescriptionDoNotValidateFlagEndDateActiveFloorNumberFormattedAddressFormattedMultiLineAddressHouseTypeLastUpdateDateLastUpdateLoginLastUpdatedByLatitudeLocationCommentsLocationDirectionsLocationIdLocationIntegrationKeyLocationLocationIdLocationSourceSystemLocationSourceSystemReferenceValueLocationStatusFlagLongitudeMailstopObjectVersionNumberLocationObjectVersionNumberPartySiteOverallPrimaryFlagPartyIdPartySiteNamePartySiteTypePostalCodePostalPlus4CodeProvinceShortDescriptionSourceSystemSourceSystemReferenceValueStartDateActiveStateStatusTimezoneCodeValidatedFlagValidationStatusCodeRelationshipGET · POST · PATCH · DELETE Relationships · 56 fields · 9 findersBackwardRoleBackwardRoleDescriptionCommentsConflictIdCreatedByCreatedByModuleCreationDateDependentFlagDirectionCodeEndDateHeadOfHouseholdFlagInfluenceLevelIsObjectSalesPartyFlagIsSubjectSalesPartyFlagJobDefinitionNameJobDefinitionPackageLastUpdateDateLastUpdateLoginLastUpdatedByObjectPartyIdObjectPartyNameObjectPartyNumberObjectSourceSystemObjectSourceSystemReferenceValueObjectTableNameObjectTypeObjectUsageCodeObjectVersionNumberObjectVersionNumber1ObjectVersionNumber2PartyIdPartyId1PercentageOwnershipPreferredContactFlagPrimaryCustomerFlagRelationshipCodeRelationshipGroupRelationshipIdRelationshipRecIdRelationshipSourceSystemRelationshipSourceSystemReferenceValueRelationshipTypeRequestIdRoleRoleDescriptionSSROwnerTableNameStartDateStatusSubjectPartyIdSubjectPartyNameSubjectPartyNumberSubjectSourceSystemSubjectSourceSystemReferenceValueSubjectTableNameSubjectTypeSubjectUsageCodesmartActionsGET 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 findersBindingSystemActionFlagURLBindingIdURLBindingNameValueSalesTeamMemberGET · POST · PATCH · DELETE Sales Account Resources · 30 fields · 1 findersAccessLevelCodeAssignmentTypeCodeCorpCurrencyCodeCreatedByCreationDateCurcyConvRateTypeCurrencyCodeEndDateActiveLastUpdateDateLastUpdateLoginLastUpdatedByLockAssignmentFlagMemberFunctionCodeObjectVersionNumberOwnerFlagPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValueResourceEmailAddressResourceIdResourceNameResourceOrgNameResourcePartyNumberResourcePhoneNumberResourceRoleNameSalesProfileIdStartDateActiveTeamMemberIdUserLastUpdateDatesmartActionsGET 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 findersBindingSystemActionFlagURLBindingIdURLBindingNameValueSourceSystemReferenceGET · POST · PATCH · DELETE Source System References · 18 fieldsConflictIdCreatedByCreatedByModuleCreationDateEndDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValueSourceSystemSourceSystemReferenceIdSourceSystemReferenceValueStartDateStatussmartActionsGET 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 84
POST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/{households_AdditionalIdentifier_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/{households_AdditionalName_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/Address/{AddressNumber}/action/PartySiteEO_setCurrentOverallPrimaryFlagPOST …/{PartyNumber}/child/Address/{AddressNumber}/action/PartySiteEO_setCurrentPrimaryFlagPOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/{households_Address_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/{households_ContactPoint_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/HouseholdContact/{RelationshipRecId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/HouseholdContact/{RelationshipRecId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/HouseholdContact/{RelationshipRecId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/HouseholdContact/{RelationshipRecId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/HouseholdContact/{RelationshipRecId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/HouseholdContact/{RelationshipRecId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/HouseholdContact/{RelationshipRecId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/HouseholdContact/{RelationshipRecId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/HouseholdContact/{RelationshipRecId}/child/smartActions/{households_HouseholdContact_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/{households_Note_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/action/RelationshipEO_setPreferredContactIdPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/{households_Relationship_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/{households_SalesTeamMember_smartActions_Id}/action/executeActionPOST …/{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/{households_smartActions_Id}/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/householdsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
HouseholdPartyNumberRFfor 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:AddressElementAttribute1, notaddresselementattribute1. - 37 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.