List households
list_householdsRetrieve households and other client circles with member names, portal access, and engagement ratings. Filter by circle name or member account to find specific groups.
Instructions
Circles (households and other groups of client accounts) with their members by name, portal access and engagement rating. Filter by name or member account. Uses GET /api/v1/circles with include=accounts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Circle name (filter[name]) | |
| sort | No | Sort field; prefix with - for descending. The API's default is name. | |
| max_results | No | Most records to return; lists are fetched 100 per request, up to 10 requests | |
| member_uuids | No | Only circles containing these accounts (filter[account_uuids]) | |
| include_contact_details | No | Include members' email addresses and third-party references. Off by default. |