Household Account Snapshot (GET)

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

Resource

/connect/nextgenwealth/accounts/accountId/snapshot

Resource Example

https://yourInstance.salesforce.com/services/data/v68.0/connect/nextgenwealth/accounts/001RO000002Kn4BYAS/snapshot

Available Version

67.0

HTTP Methods

GET

Request Parameters for GET

Parameter Name Type Description Required or Optional Available Version
accountId String ID of the account whose profile details you want to retrieve. It must be an 18-character record ID. Required 67.0
accountFields String Comma-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. Optional 67.0
primaryMemberFields String Comma-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. Optional 67.0

Response Body for GET