POST /api/v1/public/prospects/search/
Search and filter prospects or companies using flexible filters. This endpoint allows you to find leads based on various criteria before adding them to a lead list.- Auth:
X-API-Key - Method:
POST
Request Body
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
search_type | string | No | PEOPLE | Either PEOPLE or COMPANY to specify what type of leads to search for |
page | integer | No | 1 | Page number for pagination |
page_size | integer | No | 25 | Number of results per page (max 100) |
filters | object | No | {} | Filter criteria (see below) |
Filter Options
Filters can be passed as:- Strings:
"VP"- Will search for this single value - Arrays:
["VP", "Director"]- Will search for any of these values - Objects:
{"must": ["VP"], "doesnt": ["Intern"]}- For include/exclude logic
For People Search (search_type: "PEOPLE")
| Filter | Type | Description | Example Values |
|---|---|---|---|
job_title | string/array | Job title(s) to search for | "VP", ["CEO", "Founder"] |
seniority | string/array | Seniority/management level | "VP", ["Director", "C-Level", "VP"] |
department | string/array | Department/function | "Sales", ["Sales", "Marketing"] |
company_name | string/array/object | Company name(s) | "Microsoft", ["Google", "Apple"], {"must": ["Tech"], "doesnt": ["Corp"]} |
company_size | string/array | Company size range | "51-200", ["51-200", "201-500"] |
industry | string/array | Industry sector | "Technology", ["Technology", "Software"] |
prospect_location | string/array | Geographic location | "San Francisco, CA, United States", ["New York", "Los Angeles"] |
location_radius | integer | Radius for location search (in km or mi) | 25, 50 |
location_radius_unit | string | Unit for radius ("km" or "mi") | "km", "mi" |
years_experience | string/object | Years of experience range | "5-10", {"min": 5, "max": 10} |
job_change_range_days | integer | Recently changed jobs (within X days) | 90, 180 |
keywords | string/array/object | Keywords in profile | "SaaS", ["AI", "Machine Learning"] |
company_domains | string/array | Company website domain(s) | "microsoft.com", ["google.com", "apple.com"] |
company_industry_keywords | string/array | Keywords in company description | "AI", ["SaaS", "Cloud"] |
Common Company Size Values
"1-10"- 1-10 employees"11-50"- 11-50 employees"51-200"- 51-200 employees"201-500"- 201-500 employees"501-1000"- 501-1000 employees"1001-5000"- 1001-5000 employees"5001-10000"- 5001-10000 employees"10000+"- 10000+ employees
Common Seniority Levels
"Entry""Senior""Manager""Director""VP""C-Level""Owner"
For Company Search (search_type: "COMPANY")
| Filter | Type | Description | Example Values |
|---|---|---|---|
company_name | string/array | Company name | "Microsoft", ["Google", "Apple"] |
location | string/array | Geographic location | "San Francisco, CA", ["New York", "Boston"] |
industry | string/array | Industry sector | "Technology", ["Software", "SaaS"] |
company_size | string/array | Number of employees | "51-200", ["51-200", "201-500"] |
revenue | string/array | Annual revenue range | "$10M-$50M", ["$10M-$50M", "$50M-$100M"] |
company_industry_keywords | string/array | Keywords in company description | "AI", ["SaaS", "Cloud"] |
