find-leads

Attach a search to an existing table

Attach a lead search to a table that has none and run it once. Results append beneath the table's existing rows. Enrichments are optional here: the destination table is the user's own and may already carry the columns they want. 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.

post/find-leads/tables/{table_id}/search/

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

Path parameters

table_idstring uuid required

Request body

enrichmentsLeadEnrichmentOption[]

What to find out about the rows this adds. Each becomes its own column, and each is billed per row that comes back with an answer.

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.

Response

Successful Response

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 the request added, in the words to show beside them; see the create response. A run that continues in the background can add more, and the table's search runs carry every one.

rows_createdinteger required

Rows the request itself added.

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.

total_matchedinteger required

Changes

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