Skip to content
GridRouterhome

Search

Search providers, capabilities and pages

Sign inGet your free API key
Docs
API referenceWaterfalls

Get a waterfall template

GET
/v1/waterfalls/templates/{template_id}

One template by id (or an earlier id): its definition, inputs and outputs, sample_input, explained steps and catalog availability (status, vendor_keys, cost range). Public: no key needed.

Path Parameters

template_id*string

Template id, e.g. work-email

Lengthlength <= 60

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/waterfalls/templates/string"
{  "id": "string",  "title": "string",  "summary": "string",  "description": "string",  "category": "contacts",  "tags": [],  "inputs": [    {      "name": "string",      "description": "string",      "required": false    }  ],  "input_rule": "string",  "outputs": [    {      "name": "string",      "description": "string",      "required": false    }  ],  "sample_input": {    "property1": "string",    "property2": "string"  },  "speed": "fast",  "run_mode": "sync",  "sandbox": false,  "definition": {    "kind": "waterfall",    "id": "main",    "capability": "string",    "steps": [      {        "type": "endpoint",        "endpoint_id": "string",        "id": "string",        "timeout_ms": 100,        "retries": 0,        "retry_backoff_ms": 250,        "max_cost_micro": 0,        "required_fields": [],        "min_confidence": 0,        "confidence_field": "confidence",        "prefer_verified": false,        "continue_on_hit": false,        "credential": "auto",        "on_client_error": "continue",        "when": {          "field": "string",          "op": "eq",          "value": "string"        }      }    ],    "speed": {      "profile": "balanced"    },    "stop": [      {        "rule": "first_hit"      }    ],    "stop_mode": "any",    "merge": {},    "input_map": {},    "when": {      "field": "string",      "op": "eq",      "value": "string"    },    "fields": [      "string"    ],    "max_cost_micro": 0,    "deadline_ms": 500  },  "steps": [    {      "stage_id": "string",      "step": 0,      "title": "string",      "why": "string"    }  ],  "aliases": [],  "availability": {    "status": "ready",    "runnable": true,    "stages": [      {        "stage_id": "string",        "capability": "string",        "conditional": true,        "routed_endpoints": [          "string"        ],        "vendors": [          {            "slug": "string",            "name": "string",            "routed": true,            "docs_url": "string"          }        ],        "listed_vendor_count": 0,        "cost": {          "min_micro": 0,          "max_micro": 0        }      }    ],    "vendor_keys": [      {        "slug": "string",        "name": "string",        "stages": [          "string"        ]      }    ],    "cost": {      "min_micro": 0,      "max_micro": 0    }  }}

Get a waterfall run GET

Poll a run started with async or wait: status (queued, running, completed, failed, cancelled), then the golden record with _provenance per field, every attempt with its timing and error, and cost per filled field.

List waterfall templates GET

Prebuilt GTM waterfalls (work email, mobile, verification, catch-all, person and company enrichment, job change, full lead enrichment, CRM hygiene and more). Each item has its inputs, outputs, sample_input, recommended speed and run_mode, the explained steps, and availability computed from the catalog: status (ready = runnable now, sandbox = runs on a test key, needs_integration = preview only), vendor_keys (add any one per stage in Settings > Vendor keys) and a list-price cost range in micro-USD. future lists recipes that aren't buildable yet and why. Public: no key needed.