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/v1/account/search-lookalikes-bulk/{job_id}

Poll results

cURL

# 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"

import requests

url = "https://api.openfunnel.dev/api/v1/account/search-lookalikes-bulk/{job_id}"

headers = {"X-API-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://api.openfunnel.dev/api/v1/account/search-lookalikes-bulk/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.openfunnel.dev/api/v1/account/search-lookalikes-bulk/{job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.openfunnel.dev/api/v1/account/search-lookalikes-bulk/{job_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.openfunnel.dev/api/v1/account/search-lookalikes-bulk/{job_id}")
  .header("X-API-Key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.openfunnel.dev/api/v1/account/search-lookalikes-bulk/{job_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

200

{
  "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"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

200

application/json

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 | null

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.