Skip to main content
GET
List the enrichments offered at import

Authorizations

X-API-Key
string
header
required

Query Parameters

record_type
enum<string>
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.

Available options:
people,
companies,
signal_companies,
signal_people,
lookalikes,
local_businesses,
hiring_companies,
backlinks,
search_results,
post_authors
row_count
integer | null
signal_type
string | null

For a buying-signal search, the one signal it looks for. Ignored for every other search. Read only so already_covered also checks that signal's own columns.

Maximum string length: 64

Response

Successful Response

The enrichments offered for one record type, and what the rows themselves cost.

options
LeadEnrichmentOptionSchema · object[]
required
row_cost
LeadRowCostSchema · object
required

What the rows cost on top of the enrichments chosen for them. Add it to the ticked options to quote an import: before this existed the screen quoted an enrichment subtotal and called it the total, which under-quoted every buying-signal and lookalike import by the larger half.

unavailable_options
UnavailableLeadEnrichmentSchema · object[]
required

Enrichments that apply to this search but are not available right now, for any workspace. Listed so a picker can show them in their place, disabled, rather than drop them. None can be chosen: an import that asks for one is refused.