Get a household
GET/v1/households/:id
Returns the household with the given ID, with its members and its security restrictions. Send accounts=true to add its current balance and cash, the time of its most recent trade, and each of its accounts with its holdings, balances and year-to-date performance. Send crm=true to add what the household's linked CRM records hold, such as its contact information, tags, tasks, events and workflows. If your firm has no household with that ID, the response is 404.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
The household.
id is not a whole number, or accounts or crm is not true or false.
The access token is missing, invalid, or expired.
The access token does not have the read:household scope or the read:crm scope.
Your firm has no household with that ID.
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.