Lead Finder

Get a Lead Finder search

Returns a search started with POST /lead-finder/searches. While it is still running the request waits up to about six seconds for it to finish before answering, so calling it again right away is fine. A finished search's results can be read for 10 minutes: after that the search reads as status failed with error expired, and after 15 minutes it is not found. Reading a finished page again within those 10 minutes keeps its people's refs valid for another 60 minutes. Searches belonging to other workspaces are reported as not found.

get/lead-finder/searches/{id}

Request

  • Base URL: https://api.emailchaser.com/r
  • URL: https://api.emailchaser.com/r/lead-finder/searches/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Search ID (searchId)

Response

The search (status running, done or failed)

audienceKeystring

AudienceKey names the filters: the same picks in any order give the same key. Imports from these filters carry it too.

creditsPerProspectinteger
errorstring

Error is set on a failed search: rate_limited, provider_blocked, provider_unavailable (the people database is down or in maintenance; try again later), timeout, invalid_filters, budget_exhausted, expired or internal.

hasMoreboolean
maxPageinteger
messagestring
pageinteger
pageSizeinteger
rowsLeftTodayinteger

RowsLeftToday is the account's browsing allowance left this UTC day.

searchIdstring
statusstring

Status is running, done or failed.

totalinteger

Total is how many people match; TotalIsExact says whether it is a count or a lower bound, and TotalStatus whether the count has landed (pending, done or failed).

totalIsExactboolean
totalStatusstring

Example response

{
  "audienceKey": "4f1c0e9a2b7d4c3e8f6a5b1d0c9e8f7a6b5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e",
  "creditsPerProspect": 1,
  "hasMore": true,
  "maxPage": 100,
  "page": 1,
  "pageSize": 25,
  "progress": {
    "added": 1000,
    "adds": 2,
    "nextFrom": 901,
    "runningImportId": 8813
  },
  "results": [
    {
      "company": {
        "industry": "Software Development",
        "logoUrl": "https://api.emailchaser.com/lead-finder/logos/l_2mEuK4r1Xw0pVn8qFh7ZcT5bLd9sYoJ3aGk6",
        "name": "Hopper Ltd",
        "sizeBand": "51 to 200"
      },
      "firstName": "Grace",
      "jobFunction": "Sales & Business Development",
      "lastInitial": "H",
      "location": {
        "city": "Dublin",
        "country": "Ireland"
      },
      "ref": "r_Q2x9LmVwZ3JhY2VIb3BwZX",
      "seniority": "Director",
      "title": "Head of Sales"
    }
  ],
  "rowsLeftToday": 1975,
  "searchId": "s_c32d55f8dbd501c71bea43ee",
  "status": "done",
  "total": 2147,
  "totalIsExact": true,
  "totalStatus": "done"
}

Changes

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