search_leads
Search people (leads) now
Instant B2B people (leads) search, returns one page of 25 rows synchronously. Give free-text keywords OR a full Sales-style query string. Billing: 1 credit per successful page with results; the same query+page repeated within 24h is served from cache for free.
Parameterspagequerycard_nokeywords
search_companies
Search companies (accounts) now
Instant B2B company (accounts) search, returns one page of 25 rows synchronously. Give free-text keywords OR a full Sales-style query string. Billing: 1 credit per successful page with results; the same query+page repeated within 24h is served from cache for free.
Parameterspagequerycard_nokeywords
card_status
Check card status and balance
Free. Returns status, remaining credits and usage limits of the authenticated card.
Parameterscard_no
query_email
Find email for one person
Look up email addresses (plus phones and social links) for one person. Provide profile_url OR profile_urn (the profile_urn field returned by search_leads rows). Optional first_name/last_name/company improve matching. Billing: charged email_cost credits only when an email or phone is actually found; no result = no charge. Slow: can take 30-120 seconds.
Parameterscard_nocompanylast_namefirst_nameprofile_urlprofile_urn
enrich_profile
Get full profile for one person
Fetch the complete public profile of one person found by search_leads: headline, about summary, positions (experience), educations, skills, languages, public contact info (emails/phones/websites), connection count and the real public profile URL. Input is the profile_urn field from a search_leads row. Billing: 1 credit per successful fetch; repeating the same person within 24h is free (cached). Takes 5-30 seconds.
Parameterscard_noprofile_urnrequired
parse_icp
Parse ideal-customer description into search suggestions
Free. Turn a natural-language description (any language) of your ideal customer or candidate into structured suggestions: entity_type (people/company), scoring dimensions, and search filter suggestions (industry, geography, titles, company size, ...). Use the output to compose keywords/query for search_leads, search_companies or create_search_task.
Parameterscard_nodescriptionrequiredentity_type
create_search_task
Create background search task
Create a background B2B search task (people or company). Pages are fetched slowly in the background under strict rate limits. Credits are frozen upfront and settled by actual rows fetched. Returns the task plus queue position and ETA (hours).
Parametersqueryrequiredtitlecard_nopage_topage_frompage_sizetask_typerequired
List all tasks for this card with status, progress and usage snapshot.
Parameterscard_no
Get one task: status, progress, billing (frozen/charged), queue position and ETA. Does not return result rows (use get_task_results).
Parameterscard_notask_idrequired
get_task_results
Get task results
Get kept result rows of a task (paginated). Rows are simplified: name/title/company/location/email/link/page.
Parameterslimitoffsetcard_notask_idrequired
resolve_filter
Resolve filter text to search filter IDs
Free. Turn a human filter value (region "Shanghai", industry "Medical Device", title "CEO", company "Siemens", ...) into search filter options with IDs, plus a ready-to-paste filter_snippet for the query parameter of search_leads / search_companies / create_search_task. Combine snippets like: (filters:List(SNIPPET,SNIPPET),keywords:...,spellCorrectionEnabled:true).
Parameterstextcard_nofilter_typerequired
enrich_company
Get full company details
Fetch full details of one company found by search_companies: description, website, industry, headquarters, employee count and growth, revenue range, specialties, type, year founded. Input: company_id / company_urn / link from a search_companies row. Billing: free, same as company details in the web app (results cached for 24h).
Parameterslinkcard_nocompany_idcompany_urn
bulk_query_email
Batch email lookup (up to 50 people)
Start a background email lookup batch for up to 50 people. Provide profile_urns (from search_leads rows) and/or profile_urls. Deliberately slow (3-8s between people; up to 1-2 min per person worst case). Billing: email_cost credits charged ONLY per person whose email or phone is actually found. Returns job_id - poll get_bulk_email_results. One active batch per card.
Parameterscard_noprofile_urlsprofile_urns
get_bulk_email_results
Get batch email lookup results
Free. Get status and per-person results of a bulk_query_email job. Jobs expire 24h after creation and the in-memory queue is lost on server restart (credits are only charged per found email, so nothing is lost financially).
Parametersjob_idrequiredcard_no
score_rows
AI-score rows against your ICP
Score up to 25 rows against your ideal-customer profile with AI. Billing: 1 credit per call (up to 25 rows, same as AI scoring in the web app), charged only when at least one row is scored. Provide icp_description (any language) - or reuse the dimensions array returned by a previous call to skip re-parsing - plus rows like {name,title,company,location,summary}. Returns 0-100 score, verdict, confidence and a one-line reason per row. Takes a few seconds per row.
Parametersrowsrequiredlocalecard_nodimensionsentity_typeicp_description