Lead Finder

Get a lead search

One search’s status and live progress counters (companies found, companies processed, emails found) – the single target to poll while a run is in flight.

Requires one of the following scopes: leadfinder:read, all:read, all:all.

get/v1/lead-searches/{id}

Request

  • Base URL: https://api.mailbeast.ai
  • URL: https://api.mailbeast.ai/v1/lead-searches/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60

Response

idstring uuid required
querystring required
status'draft' | 'queued' | 'discovering' | 'processing' | 'crawling' | 'enriching' | 'verifying' | 'completed' | 'stopped' | 'failed' required
searchMode'companies' | 'people' required
maxResultsnumber required
discoveryFinishedboolean required

Whether the discovery phase has finished (crawl/enrich may still run).

errorMessagestring nullable

Failure reason when status is failed; otherwise null.

createdAtstring date-time required
updatedAtstring date-time required

When the search row was last updated.

completedAtstring date-time nullable

When the search reached a terminal state; null while still running.

Example response

{
  "id": "a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60",
  "query": "dental clinics in Berlin",
  "status": "processing",
  "searchMode": "companies",
  "maxResults": 500,
  "discoveryFinished": true,
  "progress": {
    "companiesFound": 183,
    "companiesProcessed": 60,
    "emailsFound": 137
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.