Search Prospects

uplead.search_prospects
ActionCRM & salesconnection required

Calls the UpLead API with the connection's credentials.

Find the contacts at one company domain, filtered by role and location.

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
UpLead
Secret shape
the UpLead API key, or {"api_key": "…"}
Resolved by
config.connection_id, else node.connection_id

Configuration

12 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
domain
Website domain of the company to search inside.
stringYes——salesforce.com
job_function
Keep only contacts in this job function.
stringNo—one of "advisory", "analyst", "creative", "education", "engineering", "finance", "fulfillment", "health", "hospitality", "human resources", "legal", "manufacturing", "marketing", "operations", "partnerships", "product", "professional service", "public service", "research", "sales", "sales engineering", "support", "trade", "unemployed"—
management_level
Keep only contacts at this seniority: manager, director, VP, C-level or C-level excluding the CEO.
stringNo—one of "M", "D", "VP", "C", "CX"—
title
Keep only contacts whose job title matches this text.
stringNo——head of marketing
title_search_mode
How to match the title: 'include' for a contains match, 'exact' for the whole title.
stringConditional—one of "include", "exact"; only with title—
city
Keep only contacts in this city.
stringNo——San Francisco
state
Keep only contacts in this state.
stringNo——CA
country
Keep only contacts in this country.
stringNo——United States
email_status
Keep only contacts whose email carries this verification verdict.
stringNo—one of "valid", "invalid", "accept_all", "unknown"—
count_only
Return only how many contacts match, without the rows and without spending credits on them.
booleanNofalse——
page
Which page of results to return.
numberNo1≥ 1—
per_page
How many contacts to return per page; UpLead's maximum is 100.
numberNo251–100—

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "city": "San Francisco",
  "count_only": false,
  "country": "United States",
  "domain": "salesforce.com",
  "page": 1,
  "per_page": 25,
  "state": "CA",
  "title": "head of marketing"
}

Output

One shape.

result

FieldTypeExample
results
The matching contacts, one object per person.
array—
count
How many contacts this page returned.
number—
total
How many contacts match the search in total.
number—
meta
UpLead's paging block: total, page, next_page, last_page.
object—
count_only
True when only the match count was requested.
boolean—
credits_remaining
The account's credit balance after this call, as UpLead reported it.
number—
{
  "count": 0,
  "count_only": false,
  "credits_remaining": 0,
  "meta": {},
  "results": [],
  "total": 0
}

Notes

  • 'domain' is required: this endpoint searches inside one company, not across UpLead's whole database.

See Search Prospects run in a workflow.

In a technical demo we add the UpLead connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.