GetLeads: Search Contacts

Search the GetLeads B2B contact database using company, role, location, industry, and contact-availability filters.

Tool ID: getleads_search_contacts

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'getleads_search_contacts',
  {
    "domains": [
      "example.com"
    ],
    "job_titles": [
      "VP of Engineering"
    ],
    "seniority": [
      "c-level"
    ]
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute getleads_search_contacts --input '{
  "domains": [
    "example.com"
  ],
  "job_titles": [
    "VP of Engineering"
  ],
  "seniority": [
    "c-level"
  ]
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "ok": true,
    "contacts": [
      {}
    ],
    "total_available": 123
  }
}

Use deepline describe getleads_search_contacts --json for the latest machine-readable contract.

Input reference

Contact search filters. All fields are optional. At least one filter or where_sql is required. Filters can be top-level or nested under a filters object (both are merged).

Name	Type	Required	Default	Details
`payload.domains`	`array`	No	—	—
`payload.job_titles`	`array`	No	—	—
`payload.seniority`	`array`	No	—	—
`payload.job_functions`	`array`	No	—	—
`payload.industries`	`array`	No	—	—
`payload.countries`	`array`	No	—	—
`payload.headquarters_countries`	`array`	No	—	—
`payload.company_size`	`array`	No	—	LinkedIn size-band labels (e.g. “51 to 200”).
`payload.company_linkedin_urls`	`array`	No	—	—
`payload.revenue`	`array`	No	—	—
`payload.cities`	`array`	No	—	—
`payload.states`	`array`	No	—	—
`payload.exclude_domains`	`array`	No	—	—
`payload.exclude_countries`	`array`	No	—	—
`payload.exclude_headquarters_countries`	`array`	No	—	—
`payload.exclude_industries`	`array`	No	—	—
`payload.exclude_job_titles`	`array`	No	—	—
`payload.email_status`	`array`	No	—	Email verification status. Use [“VALID”] for deliverable emails.
`payload.technologies`	`array`	No	—	Technologies/tools a company uses.
`payload.funding_types`	`array`	No	—	Last funding round type (e.g. “Seed”, “Series A”, “IPO”).
`payload.headquarters_cities`	`array`	No	—	—
`payload.company_name`	`string`	No	—	—
`payload.email_domain`	`string`	No	—	—
`payload.first_name`	`string`	No	—	—
`payload.last_name`	`string`	No	—	—
`payload.email_address`	`string`	No	—	—
`payload.linkedin_url`	`string`	No	—	—
`payload.company_description`	`string`	No	—	Keyword search over company LinkedIn About text.
`payload.person_description`	`string`	No	—	Keyword search over person LinkedIn bio.
`payload.linkedin_headline`	`string`	No	—	—
`payload.education`	`string`	No	—	—
`payload.certifications`	`string`	No	—	—
`payload.languages`	`string`	No	—	—
`payload.job_start_date_min`	`string`	No	—	Earliest current-role start date (YYYY-MM-DD). Format: `date`.
`payload.job_start_date_max`	`string`	No	—	Latest current-role start date (YYYY-MM-DD). Format: `date`.
`payload.skills`	`string`	No	—	Keyword search over contact skills.
`payload.domain_list_id`	`string`	No	—	Saved domain list id.
`payload.company_size_min`	`integer`	No	—	—
`payload.company_size_max`	`integer`	No	—	—
`payload.employees_min`	`integer`	No	—	Minimum company headcount (band-overlap matching).
`payload.employees_max`	`integer`	No	—	Maximum company headcount (band-overlap matching).
`payload.employee_profiles_on_linkedin_min`	`integer`	No	—	Minimum exact LinkedIn employee-profile headcount (hard cutoff).
`payload.employee_profiles_on_linkedin_max`	`integer`	No	—	Maximum exact LinkedIn employee-profile headcount (hard cutoff).
`payload.founded_year_min`	`integer`	No	—	Earliest founding year.
`payload.founded_year_max`	`integer`	No	—	Latest founding year.
`payload.total_funding_min`	`integer`	No	—	Minimum total funding raised (USD).
`payload.total_funding_max`	`integer`	No	—	Maximum total funding raised (USD).
`payload.require_email`	`boolean`	No	—	—
`payload.require_phone`	`boolean`	No	—	—
`payload.require_company_profile`	`boolean`	No	—	Skip contacts with no company name. Defaults on for Swarm domain-only searches that request company columns.
`payload.require_domain_or_headline`	`boolean`	No	—	Rank contacts with a company domain or LinkedIn headline first. remaining matches still appear later in the same page and CSV. Defaults on for Swarm. Set false for the raw sort key.
`payload.has_mobile_app`	`boolean`	No	—	—
`payload.has_web_app`	`boolean`	No	—	—
`payload.open_to_work`	`boolean`	No	—	Only contacts with LinkedIn Open to Work signal.
`payload.is_hiring`	`boolean`	No	—	Only contacts with LinkedIn Hiring badge.
`payload.limit`	`integer`	No	`1000`	Page size. Maximum: 5000.
`payload.offset`	`integer`	No	`0`	Pagination offset.
`payload.max_per_company`	`integer`	No	—	Cap contacts per company.
`payload.columns`	`array`	No	—	Columns to include by display label or internal name. Discover names with GET /api/v1/contacts/columns. Unknown Classic-only names return invalid_columns and column_replacements.
`payload.where_sql`	`string`	No	—	Advanced WHERE predicate on catalog fields. AND-combined with curated filters.

This input schema is too large for an inline display. Read the complete live contract with deepline describe getleads_search_contacts --json.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.ok`	`boolean`	No	—	—
`result.data.contacts`	`array`	No	—	—
`result.data.total_available`	`integer`	No	—	—
`result.data.total_available_is_minimum`	`boolean`	No	—	—
`result.data.offset`	`integer`	No	—	—
`result.data.limit`	`integer`	No	—	—
`result.data.returned`	`integer`	No	—	—
`result.data.has_more`	`boolean`	No	—	—
`result.data.next_offset`	`integer`	No	—	—
`result.data.max_per_company`	`integer`	No	—	—
`result.data.message`	`string`	No	—	—
`result.data.code`	`string`	No	—	—
`result.data.pagination_warning`	`string`	No	—	—
`result.data.export_offer`	`object`	No	—	—
`result.data.export_offer.total_available`	`integer`	No	—	—
`result.data.export_offer.returned`	`integer`	No	—	—
`result.data.export_offer.message`	`string`	No	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: provider_usage (provider usage).
Estimated Deepline credits: 1.75 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation