View as Markdown
Wealthbox icon

Wealthbox ACTION

List Households

Companion list action for the free-form Household id prop. Returns household-type contacts via GET /contacts so agents/users can discover valid household ids for Add Member To Household. Paginates automatically up to the requested Limit. Example: returns household objects each including id, name, type, email_addresses, and phone_numbers. Supply the optional Fields parameter (e.g. ["id","name"]) to receive a trimmed response. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Wealthbox account once, then configure and run List Households from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "wealthbox-list-households",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    wealthbox: { authProvisionId: "apn_xxxxxxx" },
    name: "Household Name",
    limit: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Households inputs
Property Type Description
name Household Name string
Optional partial household name to filter by. Example: Smith Family.
Optional
limit Limit integer
Maximum number of households to return (1-1000). Defaults to 100.
Optional
fields Fields string[]
Optional list of field names to include in each returned household object. When omitted, all fields are returned. Example: ["id", "name", "email_addresses"].
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
wealthbox-list-households
Version
0.0.2
App
Wealthbox
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes