This page documents the canonical HTTP contract for this endpoint.
The route also accepts a top-level ID array. Selection is restricted to the authenticated organization. Leads already containing a usable email, a prior not_found result (unless skip_previously_attempted is false), or lacking both full name and LinkedIn URL are skipped. This illustrates the queued case; queued responses also include job_id, operation_run_id, operationRunId, processable_ids, and optionally process_limit. Poll a queued operation with GET /api/operation-runs/{operation_run_id} (requires jobs:read). When no leads qualify it returns success and skipped details without job IDs.
Body parameters
lead_ids· optionalarray<string>
Explicit lead IDs. Provide either lead_ids or selection.
selection· optionalobject
BulkSelectionModel using ids or descriptor mode.
scope· optionalstring
Optional org or user selection scope.
source_table_id· optionalstring
Optional Research Table context.
source_table_scope· optionalstring
Optional company or lead Research Table scope.
process_limit· optionalinteger
Max number of leads to process (1-10000).
skip_previously_attempted· optionalboolean
Skip leads with prior not_found result. Defaults to true.
| Name | Type | Description |
|---|---|---|
| lead_ids | array<string> | Explicit lead IDs. Provide either lead_ids or selection. |
| selection | object | BulkSelectionModel using ids or descriptor mode. |
| scope | string | Optional org or user selection scope. |
| source_table_id | string | Optional Research Table context. |
| source_table_scope | string | Optional company or lead Research Table scope. |
| process_limit | integer | Max number of leads to process (1-10000). |
| skip_previously_attempted | boolean | Skip leads with prior not_found result. Defaults to true. |
Errors
| Status | Meaning |
|---|---|
| 400 | Invalid payload or some leads not found. |
| 401 | Invalid API key or missing auth. |
| 403 | Missing leads:read or leads:write scope. |
| 404 | No leads found for selection. |
| 503 | Failed to queue email finding task. |
