Skip to main content
GET
/
v1
/
waterfalls
Get available waterfalls
curl --request GET \
  --url https://api.example.com/v1/waterfalls/ \
  --header 'x-apikey: <x-apikey>'
[
  {
    "identifier": "email_getter",
    "name": "Email finder waterfall",
    "description": "Get email from first name, last name and company",
    "input_params": [
      {
        "name": "first_name",
        "type": "text",
        "required": true
      },
      {
        "name": "last_name",
        "type": "text",
        "required": true
      },
      {
        "name": "company",
        "type": "text",
        "required": true
      }
    ],
    "output_fields": [
      {
        "name": "email",
        "label": "Email",
        "type": "text"
      }
    ],
    "available_enrichments": [
      {
        "id": 833,
        "name": "General Enrichment",
        "description": "General data enrichment service",
        "price": "0.01",
        "params": [
          "first_name",
          "last_name",
          "company"
        ]
      },
      {
        "id": 966,
        "name": "Email Finder",
        "description": "Specialized email finding service",
        "price": "0.02",
        "params": [
          "first_name",
          "last_name",
          "company"
        ]
      }
    ],
    "is_email_verifying": true,
    "email_verifiers": [
      {
        "id": 10,
        "name": "Verify emails (Emailable)",
        "description": "Verify if emails are valid.",
        "price": "0.01"
      }
    ]
  },
  {
    "identifier": "person_getter",
    "name": "Person finder waterfall",
    "description": "Get person information from email",
    "input_params": [
      {
        "name": "email",
        "type": "text",
        "required": true
      }
    ],
    "output_fields": [
      {
        "name": "first_name",
        "label": "First name",
        "type": "text"
      },
      {
        "name": "last_name",
        "label": "Last name",
        "type": "text"
      },
      {
        "name": "linkedin_url",
        "label": "Linkedin URL",
        "type": "text"
      }
    ],
    "available_enrichments": [
      {
        "id": 833,
        "name": "General Enrichment",
        "description": "General data enrichment service",
        "price": "0.01",
        "params": [
          "email"
        ]
      }
    ],
    "is_email_verifying": false,
    "email_verifiers": []
  }
]

Headers

x-apikey
string
required

API Key for authentication

Response

Waterfalls

identifier
string
name
string
description
string
input_params
Input Params · object[]
output_fields
Output Fields · object[]
available_enrichments
Available Enrichments · object[]
is_email_verifying
boolean
email_verifiers
Email Verifiers · object[]