Skip to content

List Waterfall Configs

GET
/enrichment/waterfall/configs

List active waterfall pipelines saved for a list.

Returns configs where list_id matches OR is_global=true. The UI treats these as the “runnable pipelines for this list” set. Each summary includes the column_id clients need for POST /enrichment/waterfall/enrich.

Empty list means the caller should auto-create one (see POST /enrichment/waterfall/configs).

Authorizations

Parameters

Query Parameters

list_id
required

List ID whose saved pipelines to return

integer

List ID whose saved pipelines to return

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Paginated (by list_id filter) collection of waterfall pipeline configs.

object
configs
Array<object>

One saved waterfall pipeline attached to (or global for) a list.

column_id is the handle the worker uses to resolve config + store enrichment output. providers is a de-duplicated list of step providers so callers can see at a glance what a pipeline actually runs.

object
column_id
required
string
data_type
Any of:
string
field_to_enrich
Any of:
string
is_active
boolean
default: true
is_global
boolean
list_id
Any of:
integer
missing_credentials

Providers in this pipeline whose step is BYOK but the org has no active key (these steps will be skipped at run time). Empty when everything is runnable.

Array<string>
name
required
string
providers
Array<string>
providers_detail

Per-step credential breakdown (system vs BYOK + readiness) for this pipeline.

Array<object>

Per-step credential breakdown so callers can see, before running, which steps use graph8 system keys (charge credits) vs the org’s own BYOK key, and whether the required credential is actually present.

object
credential_ready
required

True if the step can actually run: system steps are always ready; BYOK steps are ready only when the org has an active key for that provider.

boolean
credential_source
required

‘system’ = graph8-funded; ‘byok’ = org’s own key.

string
Allowed values: system byok
is_system_provider
required

True = uses graph8-managed system key (charges credits). False = uses org BYOK key.

boolean
provider
required
string
step_count
integer
count
integer
list_id
Any of:
integer
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string