payload.free_only | boolean | No | — | Use only the remaining included people-search allowance. Never charge overage. The page may be smaller than requested. |
payload.contact_linkedin | string | No | — | LinkedIn profile URL or slug of the contact to search for (3-500 chars). |
payload.domain | string | No | — | Company domain for a company-specific search (4-500 chars). Omit for company-set searches. |
payload.company_linkedin | string | No | — | LinkedIn company page URL or slug (3-500 chars). |
payload.company_name | string | No | — | Company name to scope the search (3-500 chars. The upstream API rejects shorter names). For 1-2 character names like “2U”, pass domain or company_linkedin instead. |
payload.title_filters | array | No | — | Ordered list of boolean title filter expressions (up to 5). Best results come from narrow leadership filters like “VP Engineering OR Head of Engineering OR Director of Engineering”, not broad terms like “founder” or “sales”. |
payload.title_lists | array | No | — | Named lists of titles (up to 5 lists and 120 titles total across all lists). Matching is NOT exact in practice: live results include titles that only contain or resemble a listed title (e.g. “Staff Engineer Heat Transfer Group” for “Staff Engineer”). Filter returned titles yourself if you need exact matches. Split larger title sets across multiple requests. |
payload.departments | array | No | — | Filter by department: Leadership, Engineering, Product Management, Sales, Marketing, Customer Success, Finance, Accounting, Legal, Human Resources, Information Technology, Operations, Education, Other. |
payload.seniorities | array | No | — | Filter by seniority levels: Director, Manager, Senior, Entry, Partner (Head maps to Director. Intern and Junior map to Entry). Any other value is rejected. filter VP, C-level, founder or owner roles with title_filters instead. |
payload.location_countries | array | No | — | Filter contacts by country of residence: full names such as United States (max 50, each 1-200 chars). Accepted names are listed at https://deepline.com/people-search-countries.txt. current names such as Czechia or Türkiye are mapped to the spelling it accepts, and country codes other than US are rejected. |
payload.company_location_countries | array | No | — | Filter by company HQ country, using the same full country names as location_countries (max 50, each 1-200 chars). |
payload.company_industries | array | No | — | Filter by company industry categories from https://deepline.com/people-search-industries.txt (max 50). |
payload.company_employee_ranges | array | No | — | Filter by company headcount ranges. Valid buckets: 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+ (max 8). |
payload.experience_start_date | string | No | — | Current role started on or after this date (YYYY-MM-DD). Company-set searches require this or experience_start_date_new_hire. Format: date. Pattern: ^\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|02-(?:0[1-9]|1\d|2[0-8]))$|^(?:\d{2}(?:0[48]|[2468][048]|[13579][26])|(?:[02468][048]|[13579][26])00)-02-29$. |
payload.experience_start_date_new_hire | string | No | — | New hires whose current role started on or after this date (YYYY-MM-DD). Company-set searches require this or experience_start_date. Format: date. Pattern: ^\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|02-(?:0[1-9]|1\d|2[0-8]))$|^(?:\d{2}(?:0[48]|[2468][048]|[13579][26])|(?:[02468][048]|[13579][26])00)-02-29$. |
payload.excluded_names | array | No | — | Contact names to exclude from search results (max 100). |
payload.included_names | array | No | — | Restrict results to these contact names (max 100). Matching is by prefix, not exact: “Teresa L” returns every Teresa whose last name starts with L. Pass full names and check the returned first_name and last_name. |
payload.headline | string | No | — | Free-text filter against the contact headline or bio (3-500 chars). |
payload.page_number | integer | No | — | Page number for paginated results (1-indexed, max 100). Minimum: 1. Maximum: 100. |
payload.page_size | integer | No | — | Number of results per page (default 10, max 250). Keep this small (1-3) for targeted leadership lookups so you can inspect candidate quality. to collect a full list, use 25 or more and page until a page is empty. A page can come back short (a small one even empty) mid-results because the provider drops duplicates after cutting it, so a short page does not mean the end. Minimum: 1. Maximum: 250. |
payload.custom_fields | record | No | — | Opaque metadata echoed back in finder responses via custom_fields (max 16 keys). |