Skip to content

Preview Find People

POST
/enrichment/find-people/{config_id}/preview

Run a find-people configuration for ONE company and return who it finds, without saving. SEARCHES THE LICENSED PEOPLE CORPUS, so it is graded as a spend rather than a free preview.

Authorizations

Parameters

Path Parameters

config_id
required

Find-people configuration id (UUID).

string

Find-people configuration id (UUID).

Query Parameters

company_id
required

The company to preview.

integer

The company to preview.

Header Parameters

X-Target-Org-Id
Any of:
string

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