Helpers

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.

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

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

account

search-lookalikes-bulk

{job_id}

Poll results

# first page (also shows status)
curl -sS "https://api.openfunnel.dev/api/v1/account/search-lookalikes-bulk/JOB_ID" \
  -H "X-API-Key: YOUR_API_KEY"

# next page
curl -sS "https://api.openfunnel.dev/api/v1/account/search-lookalikes-bulk/JOB_ID?cursor=page_0001" \
  -H "X-API-Key: YOUR_API_KEY"

{
  "job_id": "d8a1bddb-44f1-4c7f-87a7-f37496354ff6",
  "status": "completed",
  "manifest": {
    "count": 600,
    "pages": 6,
    "page_size": 100,
    "credits_consumed": 600,
    "derived_query": null,
    "resolved_seed_domains": null,
    "unresolved_seed_domains": null,
    "rerank_degraded": false,
    "partial": false
  },
  "error_message": null,
  "rows": [
    {
      "name": "Acme Observability",
      "domain": "acme.com",
      "linkedin_url": "https://www.linkedin.com/company/acme",
      "headquarters": "San Francisco, United States",
      "match_reason": "Describes itself as an \"observability platform\" for engineering teams.",
      "employee_count": 120
    }
  ],
  "page": "page_0000",
  "next_cursor": "page_0001",
  "count": 100,
  "processed": 600,
  "progress_message": "completed"
}

Headers

X-API-Key

string

required

Path Parameters

job_id

string

required

The job_id returned by the bulk submit endpoint.

Query Parameters

cursor

string | null

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

limit

integer

default:100

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

Required range: 1 <= x <= 100

Response

Job status, manifest, and one page of results.

Combined job status + one page of results. Check status for completion (not next_cursor), and walk pages with next_cursor.

job_id

string

required

status

string

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.

manifest

BulkLookalikeManifest · object

Job summary; populated once the job completes.

Show child attributes

error_message

string | null

Failure reason when status is failed.

rows

InstantTraitSearchResult · object[]

Companies in the requested page (same shape as Search Lookalikes results).

Show child attributes

page

string | null

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

next_cursor

string | null

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

count

integer

default:0

Number of rows in this page.

processed

integer | null

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

progress_message

string | null

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

Cancel Bulk Lookalike JobCancel a running or pending bulk lookalike job. 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](/agent-auth/agent-auth/agent-sign-up) to get your `X-API-Key` - the only required header for this endpoint.</Info> The job moves to a transient `cancelling` state and stops at its next checkpoint. Whatever pages were already produced are kept and remain readable via the poll endpoint, and you are charged **only for the companies actually delivered** before the cancel - nothing for the abandoned remainder. The job then settles to a terminal `cancelled` status. Returns **409** if the job has already finished (`completed` / `failed` / `cancelled`), and **404** if no job with that id exists for your API key. Poll **`GET /api/v1/account/search-lookalikes-bulk/{job_id}`** for the final `cancelled` state and the partial results. ## When to cancel Cancel when finishing the job is no longer worth it - e.g. you requested a large `limit` but already have enough companies from the pages delivered so far, the query turned out too broad, or you simply want to stop spend. Because credits are billed **only for companies actually delivered** before the cancel (never the abandoned remainder), cancelling early is how you cap credit usage on an over-scoped job.

⌘I

Poll results

# first page (also shows status)
curl -sS "https://api.openfunnel.dev/api/v1/account/search-lookalikes-bulk/JOB_ID" \
  -H "X-API-Key: YOUR_API_KEY"

# next page
curl -sS "https://api.openfunnel.dev/api/v1/account/search-lookalikes-bulk/JOB_ID?cursor=page_0001" \
  -H "X-API-Key: YOUR_API_KEY"

{
  "job_id": "d8a1bddb-44f1-4c7f-87a7-f37496354ff6",
  "status": "completed",
  "manifest": {
    "count": 600,
    "pages": 6,
    "page_size": 100,
    "credits_consumed": 600,
    "derived_query": null,
    "resolved_seed_domains": null,
    "unresolved_seed_domains": null,
    "rerank_degraded": false,
    "partial": false
  },
  "error_message": null,
  "rows": [
    {
      "name": "Acme Observability",
      "domain": "acme.com",
      "linkedin_url": "https://www.linkedin.com/company/acme",
      "headquarters": "San Francisco, United States",
      "match_reason": "Describes itself as an \"observability platform\" for engineering teams.",
      "employee_count": 120
    }
  ],
  "page": "page_0000",
  "next_cursor": "page_0001",
  "count": 100,
  "processed": 600,
  "progress_message": "completed"
}