Household Account Snapshot (GET)

Get profile information for a household account, including the account type and the primary member and account field details.

Resource 

1/connect/nextgenwealth/accounts/ACCOUNT_ID/snapshot

Resource Example 

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/connect/nextgenwealth/accounts/001_RO000002_KN4_BYAS/snapshot

Available Version 

67.0

HTTP Methods 

GET

Request Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
accountIdStringID of the account whose profile details you want to retrieve. It must be an 18-character record ID.Required67.0
accountFieldsStringComma-separated list of Account field API names whose details you want to retrieve for the specified account. For example, FinServ__AUM__c and FinServ__LastInteraction__c. The API response includes data only for the specified fields. If not provided, the accountData parameter shows empty in the response.Optional67.0
primaryMemberFieldsStringComma-separated list of Account field API names to retrieve for the primary member of the household account. For example, Name, Phone, and PersonEmail. If not specified or if the household doesn’t have the primary member configured, this parameter shows empty in the API response.Optional67.0

Response Body for GET 

Household Account Snapshot Response