find-leads

Create a table from a lead search

Run a lead search and land its results in a new table. Each chosen enrichment becomes a column on the new table. A people search may choose none; every other search needs at least one. The row count is capped per search and further clamped by the plan's rows-per-table limit. A table sent without a name is named after the search. A people search leaves out the people already in the workspace's other tables unless include_people_already_in_tables is set, and says how many it skipped. The answer also names a table the same search built before, when one still exists.

post/find-leads/tables/

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/tables/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

enrichmentsLeadEnrichmentOption[]

What to find out about the rows this search adds. Optional on a paid finder. Find People and Find Companies require at least one. Each becomes its own column, and each is billed per row that comes back with an answer.

folder_idstring uuid nullable

The folder to make the new table in, as when the search was started from inside one on the Tables list. Leave it out for the top level.

include_people_already_in_tablesboolean

A people search only. By default it leaves out the people who already have a row in one of the workspace's other tables, and keeps looking until enough new people are added; the response says how many it skipped. Set true to add them again.

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.

row_limitinteger nullable

Rows to add. Clamped further by the organisation's plan cap; omit for the maximum.

table_namestring nullable

The new table's name. Omit it and the table is named after the search, the name POST /find-leads/suggest-table-name/ gives.

Response

Successful Response

enrichments_appliedLeadEnrichmentOption[]

Chosen enrichments that became a column on the new table.

enrichments_skippedLeadEnrichmentOption[]

Chosen enrichments that could not run against the records this search returned. Leads with no LinkedIn URL cannot be enriched from one. The table is still created.

import_status'running' | 'success' | 'failed'

Where one run of a table's search stands.

running while rows are still being added, then success or failed.

people_skippedinteger

People the request left out because another of the workspace's tables already has them. A run that continues in the background goes on skipping them.

provider_noticesstring[]

What the data source said about the rows it sold, in its own words; see the preview response. Empty for every data source that attaches nothing.

rows_createdinteger required
rows_wantedinteger

Rows the import set out to add in all.

run_idstring uuid nullable

The run row recording this import, when the search is persisted.

skip_limit_reachedboolean

Whether the search stopped looking after skipping as many people as one search may, so fewer rows may be added than asked for.

table_idstring uuid required
table_namestring required
table_run_request_idstring uuid nullable

The request for the table run that fills the new table's columns, when every row was added by this request: the run is minted with it as its origin. Null while rows are still being added in the background, where each batch fills its own.

total_matchedinteger required

Changes

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