// fusionrest agent · sales and service (cx)

Households

households Based on latest (2026.09)

Create, change, delete and look up Households, with additional identifier, additional name and address.

/crmRestApi/resources/11.13.18.05/households
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
I want to…List the latest 25Count recordsGet one recordCreate oneUpdate one

Try it

Response fields ·
Filters (q)

Only attributes Oracle marks as searchable are offered.

Finder
Include children (expand)
Paging and options
limit
Endpoint and headers
GET /crmRestApi/resources/11.13.18.05/households?fields=AddressElementAttribute1,AddressElementAttribute2,AddressElementAttribute3,AddressElementAttribute4,AddressElementAttribute5&limit=25&onlyData=true
Response shape (placeholders)
{
  "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

AttributeTypeUse
AddressElementAttribute1text · max 150Optional on createUpdatableSearchable
AddressElementAttribute2text · max 150Optional on createUpdatableSearchable
AddressElementAttribute3text · max 150Optional on createUpdatableSearchable
AddressElementAttribute4text · max 150Optional on createUpdatableSearchable
AddressElementAttribute5text · max 150Optional on createUpdatableSearchable
AddressLine1text · max 240Optional on createUpdatableSearchable
AddressLine2text · max 240Optional on createUpdatableSearchable
AddressLine3text · max 240Optional on createUpdatableSearchable
AddressLine4text · max 240Optional on createUpdatableSearchable
AddressLinesPhonetictext · max 560Optional on createUpdatableSearchable
AddressNumbertext · max 30Required on createSearchable
AddressTypetextOptional on createUpdatable
AnnualIncomenumberOptional on createUpdatableSearchable
AssignmentExceptionFlagyes/no · max 1 · default falseRead-only
AverageAgenumberOptional on createUpdatableSearchable
Buildingtext · max 240Optional on createUpdatableSearchable
CertificationLeveltext · max 30Optional on createUpdatableSearchable
CertificationReasonCodetext · max 30Optional on createUpdatableSearchable
Child0to6NumbernumberOptional on createUpdatableSearchable
Child13to18NumbernumberOptional on createUpdatableSearchable
Child7to12NumbernumberOptional on createUpdatableSearchable
Citytext · max 60Optional on createUpdatableSearchable
ClassificationCategorytextOptional on createUpdatable
ClassificationCodetextOptional on createUpdatable
Commentstext · max 2000Optional on createUpdatableSearchable
ConflictIdnumber · default 0Optional on createUpdatableSearchable
CorpCurrencyCodetext · max 15Optional on createUpdatableSearchable
Countrytext · max 2Required on createUpdatableSearchable
Countytext · max 60Optional on createUpdatableSearchable
CreatedBytext · max 64Read-onlySearchable
CreatedByModuletext · default HZ_WSOptional on createUpdatable
CreatedByModule1text · max 30Optional on createUpdatableSearchable
CreationDatedate-timeRead-onlySearchable
CurcyConvRateTypetext · max 30Optional on createUpdatableSearchable
CurrencyCodetext · max 15Optional on createUpdatableSearchable
DeleteFlagyes/noRead-only
DependentsNumbernumberOptional on createUpdatableSearchable
EffectiveLatestChangetext · max 1 · default YOptional on createUpdatableSearchable
EffectiveSequencenumberRequired on createUpdatableSearchable
EmailAddresstext · max 320Required on createUpdatableSearchable
EmailContactPointIdnumberRead-onlySearchable
EmailContactPointTypetext · max 30 · default EMAILRead-onlySearchable
EmailFormattext · max 30Optional on createUpdatableSearchable
EmailVerificationDatedateOptional on createUpdatable
EmailVerificationStatustext · max 30Optional on createUpdatable
ExistingCustomerFlagyes/no · max 1 · default falseRead-only
ExistingCustomerFlagLastUpdateDatedateRead-only
FavoriteHouseholdFlagyes/no · max 10 · default falseOptional on createUpdatableSearchable
FloorNumbertext · max 40Optional on createUpdatableSearchable
FormattedAddresstextRead-only
FormattedPhoneNumbertextRead-only
GroupPartyIdnumberOptional on createUpdatableSearchable
GroupTypetext · max 30 · default HOUSEHOLDRead-onlySearchable
HouseholdNametext · max 360Required on createUpdatableSearchable
HouseholdProfileIdnumberOptional on createSearchable
HouseholdSizenumberOptional on createUpdatableSearchable
LastAssignmentDatedateRead-onlySearchable
LastAssignmentDateTimedate-timeRead-onlySearchable
LastUpdateDatedate-timeRead-onlySearchable
LastUpdateLogintext · max 32Read-onlySearchable
LastUpdatedBytext · max 64Read-onlySearchable
Mailstoptext · max 60Optional on createUpdatableSearchable
MedianAgenumberOptional on createUpdatableSearchable
NamedFlagyes/no · max 1 · default falseOptional on createUpdatableSearchable
ObjectVersionNumberEmailnumberOptional on createUpdatableSearchable
ObjectVersionNumberGroupnumberOptional on createUpdatableSearchable
ObjectVersionNumberOwnernumberRead-onlySearchable
ObjectVersionNumberPartynumberOptional on createUpdatableSearchable
ObjectVersionNumberPhonenumberOptional on createUpdatableSearchable
ObjectVersionNumberSalesAccountnumberOptional on createUpdatableSearchable
OwnerEmailAddresstext · max 320Read-onlySearchable
OwnerNametext · max 360Read-onlySearchable
OwnerPartyIdnumberOptional on createUpdatableSearchable
OwnerPartyId1numberRead-onlySearchable
OwnerPartyNumbertext · max 30Read-onlySearchable
PartyIdnumberRead-onlySearchable
PartyNumbertext · max 30Required on createSearchable
PartyNumberKeytext · max 30Required on createUpdatableSearchable
PartyStatustext · max 1 · default ARead-onlySearchable
PartyTypetext · max 30 · default GROUPRead-onlySearchable
PartyUniqueNametext · max 900Read-onlySearchable
PhoneAreaCodetext · max 20Optional on createUpdatableSearchable
PhoneContactPointIdnumberRead-onlySearchable
PhoneContactPointTypetext · max 30 · default PHONERead-onlySearchable
PhoneCountryCodetext · max 10Optional on createUpdatableSearchable
PhoneExtensiontext · max 20Optional on createUpdatableSearchable
PhoneNumbertext · max 40Optional on createUpdatableSearchable
PhoneVerificationDatedateOptional on createUpdatable
PhoneVerificationStatustext · max 30Optional on createUpdatable
PostalCodetext · max 60Optional on createUpdatableSearchable
PostalPlus4Codetext · max 20Optional on createUpdatableSearchable
PreferredContactMethodtext · max 30Optional on createUpdatableSearchable
PreferredFunctionalCurrencytext · max 15Optional on createUpdatableSearchable
PrimaryAddressIdnumberRead-onlySearchable
PrimaryContactEmailtextRead-only
PrimaryContactNametext · max 255Read-only
PrimaryContactPartyIdnumberOptional on createUpdatableSearchable
PrimaryContactPartyNumbertextOptional on createUpdatableSearchable
PrimaryContactPhonetextRead-only
PrimaryContactRoletextOptional on create
PrimaryContactSourceSystemtextOptional on createUpdatableSearchable
PrimaryContactSourceSystemReferenceValuetextOptional on createUpdatableSearchable
Provincetext · max 60Optional on createUpdatableSearchable
RawPhoneNumbertext · max 60Optional on createUpdatableSearchable
RecordSettext · max 30Read-onlySearchable
SSROwnerTableNametext · max 30 · default HZ_PARTIESRead-only
SalesProfileIdnumberOptional on createSearchable
SalesProfileNumbertext · max 30Optional on createUpdatableSearchable
SalesProfileStatustext · max 30Optional on createUpdatableSearchable
SellToPartySiteIdnumberRead-onlySearchable
SourceObjectTypetext · max 255 · default SALES_PARTYRead-only
SourceSystemtextOptional on createUpdatableSearchable
SourceSystemReferenceValuetextOptional on createUpdatableSearchable
Statetext · max 60Optional on createUpdatableSearchable
StringPartyIdtext · max 255Read-only
Typetext · max 30Optional on createUpdatableSearchable
UniqueNameSuffixtext · max 540Optional on createUpdatableSearchable
UpdateFlagyes/noRead-only
WealthAmountnumberOptional 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.

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.

Actions 84

Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.

Use in AI Agent Studio

More in For Builders.

Pitfalls