Skip to content

List Waterfall Templates

GET
/enrichment/waterfall/templates

Pre-built waterfalls for standard fields, with recommended providers. Free.

Authorizations

Parameters

Query Parameters

field
Any of:
string
<= 120 characters

One field, e.g. CONTACT_WORK_EMAIL.

list_id
Any of:
integer

Only templates for this list’s record type.

include_optional_steps

Include config.optional_steps: further providers that can fill the field. They run only when you pass them in providers, never in the default order. supported_providers lists default plus optional.

boolean
default: true

Include config.optional_steps: further providers that can fill the field. They run only when you pass them in providers, never in the default order. supported_providers lists default plus optional.

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