Skip to main content
POST
Start lead search

Authorizations

Authorization
string
header
required

Workspace API key (loice_sk_ + 48 hex characters), created under Settings → API Keys. Sent as Authorization: Bearer loice_sk_…. Invalid, missing, or expired keys are rejected with 401 before any billable work happens.

Body

application/json
filters
object

At least one non-empty filter is required — unless continueFromRunId is set, in which case filters may be omitted (the continuation inherits the prior run’s criteria; submitted filters must match them).

count
integer

How many leads to deliver (default 25, maximum 10000). Billing is per lead actually delivered, never per lead requested. On a continuation this means additional leads beyond the prior run.

Required range: 1 <= x <= 10000
continueFromRunId
string

Id of a finished run to continue ("load more" / retry after a partial failure). The new run inherits its criteria, resumes where it stopped, and never re-delivers or re-bills leads the prior run or any run it continued already delivered. Only the newest run of a search can be continued: a run that already has a continuation answers 409 run_already_continued.

page
integer

Fetch exactly this one source page and stop there — the on-demand fetch behind as-if-local pagination. On a continuation it replaces resuming sequentially; on a new search it picks the page. The run delivers what that page holds (at most count) and is billed only for those; leads the chain already delivered are never re-billed. Without page, a run reads pages in order until it has count leads.

Required range: 1 <= x <= 100

Response

Run created (poll GET /api/v1/lead-search/runs/{runId}), or refused uncharged with reason: "insufficient-credits" when the balance cannot cover the worst case — inspect run and reason.

data
object
required