Get the asset allocation of a household

GET 
/v1/households/:id/allocation-details

Returns the allocation of the household with the given ID to asset classes: its current allocation, its target allocation, and its target from the household's model alone. The target allocation is the household's model when one is assigned to the household and the household's modelAssignmentStrategy is completion or soft_completion, otherwise the model of each account weighted by the account's share of the household balance. When the household's modelAssignmentStrategy is null, the firm's applies. If your firm has no household with that ID, the response is 404.

Request

Responses

200

The current and target asset allocation of the household.

400

id is not a whole number.

401

The access token is missing, invalid, or expired.

403

The access token does not have the read:household scope or the read:crm scope.

404

Your firm has no household with that ID.

429

Too many requests. Wait the number of seconds in the Retry-After-per-person header (script-audience tokens) or the Retry-After header (other requests) before you retry. See Rate limit.