Workbench

Configure Workbench Find People

Search for contacts at each company row. SPENDS CREDITS.

This queries the licensed people corpus and writes the matches into a contact table. The rows land LOCKED: the search is what this costs, and revealing each contact's details then costs a further credit per row through unlock-rows.

max_total_people is the real cost control - it is a hard ceiling across every company row, not a per-company hint. broad_search_acknowledged must be set to run with NO filters, because an unfiltered search returns the widest and most expensive possible result.

post/workbench/tables/{table_id}/find-people/configure

Request

Base URL: https://be.graph8.com/api/v1
URL: https://be.graph8.com/api/v1/workbench/tables/{table_id}/find-people/configure
Auth: HTTP bearer

Path parameters

table_idstring required

Workbench table id (UUID).

Headers

Authorizationstring nullable

X-Target-Org-Idstring nullable

Request body

namestring

domain_columnstring required

Column holding company domains or LinkedIn URLs.

lookup_field'COMPANY_DOMAIN' | 'COMPANY_LINKEDIN_URL'

broad_search_acknowledgedboolean

Confirm an EMPTY filter set is intentional. An unfiltered search returns the widest - and most expensive - possible result.

max_people_per_companyinteger

max_total_peopleinteger

Hard ceiling across every company row.

destination_table_idstring nullable

create_destination_tableboolean

destination_table_namestring nullable

auto_create_columnsboolean

skip_existingboolean

company_name_columnstring nullable

Response

Successful Response

dataEnrichmentPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.