View as Markdown
Hunter icon

Hunter ACTION

List Leads

List all your leads with comprehensive filtering options. The leads are returned in sorted order, with the most recent leads appearing first. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Hunter account once, then configure and run List Leads 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: "hunter-list-leads",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hunter: { authProvisionId: "apn_xxxxxxx" },
    leadsListId: "Leads List ID",
    email: "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.

List Leads inputs
Property Type Description
leadsListId Leads List ID string
Only returns the leads belonging to this list.
Optional Dynamic
email Email string
Filter leads by email. Use * for any value, ~ for empty, or specific email.
Optional
firstName First Name string
Filter leads by first name. Use * for any value, ~ for empty, or specific name.
Optional
lastName Last Name string
Filter leads by last name. Use * for any value, ~ for empty, or specific name.
Optional
position Position string
Filter leads by position. Use * for any value, ~ for empty, or specific position.
Optional
company Company string
Filter leads by company. Use * for any value, ~ for empty, or specific company.
Optional
industry Industry string
Filter leads by industry. Use * for any value, ~ for empty, or specific industry.
Optional
website Website string
Filter leads by website. Use * for any value, ~ for empty, or specific website.
Optional
countryCode Country Code string
Filter leads by country code (ISO 3166-1 alpha-2). Use * for any value, ~ for empty.
Optional
companySize Company Size string
Filter leads by company size. Use * for any value, ~ for empty, or specific size.
Optional
source Source string
Filter leads by source. Use * for any value, ~ for empty, or specific source.
Optional
twitter Twitter string
Filter leads by Twitter handle. Use * for any value, ~ for empty, or specific handle.
Optional
linkedinUrl LinkedIn URL string
Filter leads by LinkedIn URL. Use * for any value, ~ for empty, or specific URL.
Optional
phoneNumber Phone Number string
Filter leads by phone number. Use * for any value, ~ for empty, or specific number.
Optional
syncStatus Sync Status string
Only returns the leads matching this synchronization status.
Optional
sendingStatus Sending Status string[]
Only returns the leads matching these sending status(es).
Optional
verificationStatus Verification Status string[]
Only returns the leads matching these verification status(es).
Optional
lastActivityAt Last Activity string
Only returns the leads matching this last activity.
Optional
lastContactedAt Last Contacted string
Only returns the leads matching this last contact date.
Optional
query Query string
Only returns the leads with First Name, Last Name, or Email matching the query.
Optional
limit Limit integer
A limit on the number of leads to be returned. Limit can range between 1 and 1,000. Default is 20.
Required

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
hunter-list-leads
Version
0.0.3
App
Hunter
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes