LeadBoxer ACTION
List Leads
Retrieve a list of leads. See the documentation
- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's LeadBoxer 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: "leadboxer-list-leads",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
leadboxer: { authProvisionId: "apn_xxxxxxx" },
search: "Search",
limit: 10,
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "leadboxer-list-leads",
"configured_props": {
"leadboxer": { "authProvisionId": "apn_xxxxxxx" },
"search": "Search",
"limit": 10
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "leadboxer",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "leadboxer-list-leads",
arguments: {
search: "Search",
limit: 10,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
search Search | string | Keyword or phrase to search across all searchable fields. Search is case-insensitive for text fields. Defaults to * to match all results. Optional |
limit Limit | integer | Number of rows to return in the response. Optional |
locale Locale | string | Locale for formatting the prettyLastEvent field in the response. Determines the language and regional formatting (e.g., dates, text) returned by the API. Optional |
nextToken Next Token | string | Token returned after each request, used to fetch the next page of results. Each token is valid for 10 minutes. Optional |
criteriaTextFilter Criteria Text Filter | string | Text-based filter expression used to filter result fields. Format: field|operator|value. Multiple filters are comma-separated. Optional |
criteriaNumberFilter Criteria Number Filter | string | Numeric filter expression used to filter results based on numeric fields. Format: field|operator|value. Multiple filters are comma-separated. Supported numeric operators include greaterthan, lessthan, is, isnot, between, and notbetween. The between and notbetween operators use the format min-max. Optional |
criteriaTimeFilter Criteria Time Filter | string | Time-based filter expression used to filter results by time field. Format: field|operator|value. Allowed fields (same as Time Field): eventEsTimestamp (Last Seen), first_session_unix_timestamp (First Seen). Supported operators: exactly (integer value, 0 = Today, 1 = Yesterday), lessthan (integer value, e.g. 6 = last 7 days), between (date range in format dd/MM/yyyy-dd/MM/yyyy). Locale settings are taken into account while interpreting dates and returning results. Required |
criteriaFieldFilter Criteria Field Filter | string | Field-based filter used to include leads based on field presence. Format: operator|field1;field2. Allowed operator: hasanyvalue. Allowed fields: firstName, lastName, email. Multiple fields can be provided using semicolons. Optional |
criteriaExitLinkFilter Criteria Exit Link Filter | string | Exit link filter used to include or exclude leads based on exit link values. Format: field|operator|value. Supported operators: contains, is, isnot, doesnotcontain. Multiple values can be provided using semicolons. Optional |
criteriaLeadscoreFilter Criteria Lead Score Filter | integer | Minimum lead score threshold (0-100). Only records with lead scores greater than the provided number are returned. Optional |
criteriaDisplayFilter Criteria Display Filter | string[] | Display filter used to control which types of leads are returned. Selecting unidentified returns leads that could not be identified as a company or a person. Optional |
timeField Time Field | string | Time field used for filtering. Required |
usePresetExclusionList Use Preset Exclusion List | string | Use a preset exclusion list of criteria to exclude from results. Optional |
userId User ID | integer | The ID of the user to filter leads by. Optional |
timeZone Time Zone | string | Time zone used when parsing timestamps and evaluating time-based filters. If not provided, the default time zone is Europe/Amsterdam. Optional |
sortBy Sort By | string | Sort results by a specific field and direction. Format: field|direction. Allowed fields: lastEvent, _score. Allowed directions: asc, desc. 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
- leadboxer-list-leads
- Version
- 0.0.2
- App
- LeadBoxer
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗