Sign in

v1

latestOpenAPI 3.1.02026-07-22103475.9 KB
Search Lookalikes Bulk Results

Search Lookalikes Bulk Results

Poll a bulk lookalike job and page through its results. Submit a job first via POST /api/v1/account/search-lookalikes-bulk ("Search Lookalikes Bulk", under Company Search), which returns a job_id.

<Info>No API key yet? Sign up via Agent Auth to get your X-API-Key - the only required header for this endpoint.</Info>

This single endpoint returns both the job status (pending → running → completed / failed), a manifest summary once complete, and one page of result rows. Walk pages by passing the returned next_cursor as ?cursor=.

Check status for completion - not next_cursor. A still-running job can return a null next_cursor simply because later pages haven't been written yet; only status: "completed" means the full result set is available.

No credits are charged for polling - the job's credits are billed once, when it completes.

get/api/v1/account/search-lookalikes-bulk/{job_id}

Path parameters

job_idstring required

The job_id returned by the bulk submit endpoint.

Query parameters

cursorstring nullable

Page to read, e.g. page_0003 (use the next_cursor from the previous response). Omit for the first page.

limitinteger

Accepted for forward-compatibility; page size is fixed at write time, so this is currently ignored.

Headers

X-API-Keystring required

Response

Job status, manifest, and one page of results.

job_idstring required
statusstring required

pending, running, cancelling, cancelled, completed, or failed. cancelling is transient (a cancel was requested); the job then settles to terminal cancelled with a partial manifest of the pages already delivered.

error_messagestring nullable

Failure reason when status is failed.

pagestring nullable

Name of the page returned, e.g. page_0003.

next_cursorstring nullable

Pass as ?cursor= to fetch the next page; null on the last available page.

countinteger

Number of rows in this page.

processedinteger nullable

Live progress: qualified companies delivered so far toward the requested limit. Null until the job starts producing progress.

progress_messagestring nullable

Coarse stage label, e.g. retrieving_companies / qualifying_companies / reranking_companies / completed / cancelled.