List waterfall templates
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.
Query Parameters
contacts, people, company or composite
Value in
- "contacts"
- "people"
- "company"
- "composite"
Text to match in id, title, summary, tags or capability
length <= 80Only templates that can run now (ready or sandbox)
Include sandbox templates (default true)
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/waterfalls/templates"{ "items": [ { "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 } } } ], "future": [ { "id": "string", "title": "string", "summary": "string", "category": "contacts", "blocked_by": "string" } ]}Get a waterfall template GET
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.
Update a waterfall draft PUT
Replace the draft definition, title or description. Published versions never change.