find-leads

Preview matching leads

Fetch a preview of at most five of the leads matching a set of filters. The answer is the column plan the table would have plus, for each sample lead, the values of the revealed columns only: a person's name, job title and company, or a company's name. Every other value, email included, stays on the server until the search becomes a table. Unlike counting, retrieving leads is billable upstream, so previews are explicit, never automatic, and capped far below a search. Search types whose rows cost credits offer no preview at all and answer 422: ask GET /find-leads/columns/ for preview_supported before showing the button. The answer also names a table the same search built before, when one still exists.

post/find-leads/preview/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/find-leads/preview/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

record_type'people' | 'companies' | 'signal_companies' | 'signal_people' | 'lookalikes' | 'local_businesses' | 'hiring_companies' | 'backlinks' | 'search_results' | 'post_authors' required

Which dataset a search runs against, and so which provider serves it.

Values are persisted in String(16) columns, so every member must stay within 16 characters.

Response

Successful Response

already_in_tablesinteger nullable

How many of the sample rows are people another of your tables already holds. A people search leaves them out unless include_people_already_in_tables is set, so this says what that choice decides before anything is added. Null for every other search.

provider_noticesstring[]

What the data source said about the answer, in its own words. The signals data source narrows the scanned window to the most recent 14 days whenever an industry, size, revenue or job filter is set, and says so here rather than in the rows. Empty for every other search.

rowsobject[] required

At most five sample leads, each a map from a revealed column's label to its value as text, blank where the lead has none. For a people search that is the person's name, job title and company; for a company search, the company's name. No other value is sent, and email is never among them: finding it is what an enrichment does once the search is a table.

totalinteger required

Changes

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