View as Markdown
White Swan icon

White Swan ACTION

Get Referred Clients Info

Retrieves information about clients referred from the user's White Swan account. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's White Swan account once, then configure and run Get Referred Clients Info 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: "white_swan-get-referred-clients-info",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    white_swan: { authProvisionId: "apn_xxxxxxx" },
    clientEmail: "Client Email",
  },
})

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.

Get Referred Clients Info inputs
Property Type Description
clientEmail Client Email string
Email of the client to retrieve information
Required Dynamic

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
white_swan-get-referred-clients-info
Version
0.0.2
App
White Swan
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes