Skip to content

Configure Find People

POST
/enrichment/find-people/configure

Find contacts at every company on a list. SPENDS CREDITS.

This reads as configuration and is not one. The search runs against the licensed people corpus, and auto_import true imports the results with no review step - so a single call can move thousands of contacts into a list.

max_total_people is the ceiling that matters: it caps the whole run, not each company. max_people_per_company only shapes the distribution.

Found contacts land with their details MASKED. Revealing them costs a further credit per contact.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Set up a people search across a company list.

object
auto_import

Import results as soon as they are found, with no review step. This is what turns a saved configuration into an immediate run.

boolean
column_mappings
Any of:
Array<object>

Map a search result field onto a destination column.

object
source_field
required
string
target_column
required
string
company_identifier_column
Any of:
string
create_new_list
boolean
destination_list_id
Any of:
integer
list_id
required

Source COMPANY list.

integer
max_people_per_company
integer
default: 5 >= 1 <= 50
max_total_people
Any of:
integer
>= 1
name
required
string
new_list_name
Any of:
string
search_filters
Array<object>

One people-search condition.

object
field
required
string
operator
required
string
value
Array
skip_across_companies
boolean
skip_existing_in_destination
boolean

Responses

200

Successful Response

object
data
required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string