Start a durable lead search
start_lead_searchLaunch an asynchronous lead-search job that compiles business prospects and returns a job ID for progress tracking, paging, refinement, retry, and CSV or JSON export.
Instructions
Use for the recommended durable asynchronous workflow. Creates a private queued search job and returns a job id plus jobToken for progress polling, cursor paging, refinement, retry, cancellation, and CSV or JSON export.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| brief | No | Natural-language business, geography, required signals, and exclusions. Use this instead of separate target and geography. | |
| limit | No | Maximum accepted prospects retained by the job. | |
| fields | No | Business fields to retain. Website and source evidence remain available for verification. | |
| target | No | Business type or concise ideal-customer target. Pair with geography when brief is omitted. | |
| geography | No | City, region, country, or Worldwide. Required with target when brief is omitted. | |
| qualifier | No | Publicly verifiable requirements and exclusions. | |
| idempotencyKey | No | Stable key for safely retrying the same job creation request. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Stable job identifier. Use it with jobToken in every lifecycle call. | |
| status | Yes | Current durable job state. | |
| cacheHit | No | ||
| jobToken | No | Private bearer token required to read, refine, or export this job. | |
| retryUrl | Yes | Authenticated REST URL for creating a replacement after retryable failure. | |
| cancelUrl | Yes | Authenticated REST URL for canceling queued or running work. | |
| exportUrl | Yes | Authenticated CSV export URL. Add format=json for JSON. | |
| statusUrl | Yes | Authenticated REST URL for job status and result pages. | |
| resultCount | No | ||
| expiresInSeconds | Yes | Seconds until the private job and token expire. |