List households
GET/v1/households
Returns your firm's active households, in order of name. Send include-inactive=true to include archived households, and hasModel to return only the households with a model or only those without one; totalCount counts only the households that match. Send balances=true to add each household's current balance and cash, and crm=true to add the CRM user the household is assigned to, its tags and its service tier, from its linked CRM records.
Request
Responses
- 200
- 400
- 401
- 403
- 429
A page of households.
balances, crm or include-inactive is not true or false, limit or offset is not a whole number, or limit is less than 1.
The access token is missing, invalid, or expired.
The access token does not have the read:household scope or the read:crm scope.
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.