v1

latestOpenAPI 3.1.0Proprietary2026-07-265759203.4 KB

Start Deep Search (Async)

Start a deep, agentic search from a natural language query. Returns a task ID to poll.

post/search/start-deep-search

Headers

x-api-keystring nullable

Request body

querystring required

Natural-language search query.

mode'people' | 'company'

Search mode: 'people' or 'company'.

max_resultsinteger

Maximum number of results to return across pages.

search_idstring nullable

Optional client-supplied search ID for idempotent retries.

output_mode'csv' | 'query_only'

Output mode: 'csv' to export, 'query_only' to return parsed query only.

exclude_public_idsstring[] nullable

People-mode inline identifiers to exclude from results, applied as a post-filter. Accepts LinkedIn public IDs or profile URLs. For company searches, use exclude_entity_ids. Max 1000.

exclude_entity_idsstring[] nullable

Inline identifiers to exclude from results, applied as a post-filter. People mode: LinkedIn public IDs or profile URLs. Company mode: numeric LinkedIn company IDs, company URLs/slugs, or exact website domains (values that resolve to no or multiple companies are ignored). Max 1000.

exclude_list_idsstring[] nullable

Saved exclusion-list IDs to apply as a post-filter. Each list's entity type must match the search mode (person lists for people searches, company lists for company searches). Max 5 (10 for organizations with extended exclusion limits).

Response

Successful Response

task_idstring required

Async task ID; poll for status with this value.

statusstring required

Initial task status, typically 'queued'.

messagestring required

Human-readable status message.