find-leads

Replace the search behind a table

Update a table's persisted search criteria without running them.

put/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.

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

next_run_atstring date-time nullable required
queryobject required
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 required
schedule_at_minutesinteger nullable required
schedule_cadence'daily' | 'weekly' | 'monthly' | 'quarterly' | 'custom' required

How often a table's search runs on its own: on a calendar step, or every few days.

schedule_every_daysinteger nullable required
schedule_starts_onstring date nullable

The first day the schedule may run, in its own timezone; null when it started at once.

schedule_timezonestring nullable required
table_idstring uuid required
updated_atstring date-time required

Changes

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