View as Markdown
WhatConverts icon

WhatConverts ACTION

Find Lead

Find a lead in WhatConverts. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's WhatConverts account once, then configure and run Find Lead 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: "whatconverts-find-lead",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    whatconverts: { authProvisionId: "apn_xxxxxxx" },
    accountId: 10,
    profileId: 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.

Find Lead inputs
Property Type Description
accountId Account ID integer
Your WhatConverts Account ID
Optional Dynamic
profileId Profile ID integer
The ID of the profile the lead belongs to
Optional Dynamic
leadType Lead Type string
Lead type to return for this request
Optional
leadStatus Lead Status string
Lead status to return for this request
Optional
startDate Start Date string
Start date for this request in date or date/time ISO 8601 format (UTC); 2015-11-10 or 2015-11-10T00:00:00Z. Date range can include up to 400 days.
Optional
endDate End Date string
End date for this request in date or date/time ISO 8601 format (UTC); 2015-11-10 or 2015-11-10T00:00:00Z. Date range can include up to 400 days.
Optional
order Order string
Order in which to return the leads by date created
Optional
quotable Quotable string
Quotable type to return for this request
Optional
quoteValue Quote Value string
Return leads that have a quote value
Optional
salesValue Sales Value string
Return leads that have a sales value
Optional
phoneNumber Phone Number string
Return leads for the contacts that have this E.164 formatted phone number
Optional
emailAddress Email Address string
Return leads for the contact that have this email address
Optional
spam Spam boolean
If true will return only spam leads
Optional
duplicate Duplicate boolean
If true will return only duplicate leads
Optional
leadSource Lead Source string
Return leads that have this lead source
Optional
leadMedium Lead Medium string
Return leads that have this lead medium
Optional
leadCampaign Lead Campaign string
Return leads that have this lead campaign
Optional
leadContent Lead Content string
Return leads that have this lead content
Optional
leadKeyword Lead Keyword string
Return leads that have this lead keyword
Optional
maxResults Max Results integer
The maximum number of results to return. Default: 100, Maximum: 2500
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
whatconverts-find-lead
Version
0.0.2
App
WhatConverts
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes