---
title: "Configure Find People"
method: POST
path: "/enrichment/find-people/configure"
tags: ["Enrichment"]
---

# Configure Find People

`POST /enrichment/find-people/configure`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/enrichment/find-people/configure`
- Auth: HTTP bearer

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.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ConfigureFindPeopleRequest: Set up a people search across a company list.
  - `name` string, required
  - `list_id` integer, required: Source COMPANY list.
  - `search_filters` SearchFilterDto[]
    - `field` string, required
    - `operator` string, required
    - `value` unknown[]
      - unknown
  - `column_mappings` ColumnMappingDto[], nullable
    - `source_field` string, required
    - `target_column` string, required
  - `company_identifier_column` string, nullable
  - `max_people_per_company` integer
  - `max_total_people` integer, nullable
  - `destination_list_id` integer, nullable
  - `create_new_list` boolean
  - `new_list_name` string, nullable
  - `skip_existing_in_destination` boolean
  - `skip_across_companies` boolean
  - `auto_import` boolean: Import results as soon as they are found, with no review step. This is what turns a saved configuration into an immediate run.

## Response `200`

Successful Response

- ApiResponseEnrichmentPayload
  - `data` EnrichmentPayload, 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.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)