← Tools Reference

Waterfall

Waterfall integration (Data, Marketing). Imported from open-connector.

API key7 toolshttps://api.waterfall.io
POST
waterfall_verify_email
Verify one email address with Waterfall and return deliverability status.

/v1/verify/email

1 parameter
ParamTypeRequiredDescription
emailstringrequiredEmail address to verify.
POST
waterfall_launch_contact_enrichment
Launch a Waterfall contact enrichment job and return the job envelope.

/v1/enrichment/contact

9 parameters
ParamTypeRequiredDescription
emailstringoptionalProfessional or personal email address to enrich.
linkedinstringoptionalLinkedIn profile URL or slug for the contact.
full_namestringoptionalFull name of the contact.
first_namestringoptionalFirst name of the contact.
last_namestringoptionalLast name of the contact.
domainstringoptionalCompany domain used with the contact name.
include_phonesbooleanoptionalWhether Waterfall should also run phone enrichment.
webhook_urlstringoptionalWebhook URL that Waterfall should call when the job completes.
custom_fieldsobjectoptionalCustom metadata to echo back in Waterfall finder responses.
GET
waterfall_get_contact_enrichment
Retrieve Waterfall contact enrichment job state and output by job ID.

/v1/enrichment/contact

1 parameter
ParamTypeRequiredDescription
job_idstringrequiredThe Waterfall job ID returned by a launcher action.
POST
waterfall_launch_company_enrichment
Launch a Waterfall company enrichment job and return the job envelope.

/v1/enrichment/company

5 parameters
ParamTypeRequiredDescription
domainstringoptionalCompany domain or full URL to enrich.
linkedinstringoptionalCompany LinkedIn URL or slug to enrich.
namestringoptionalCompany name to enrich when domain or LinkedIn is not available.
webhook_urlstringoptionalWebhook URL that Waterfall should call when the job completes.
custom_fieldsobjectoptionalCustom metadata to echo back in Waterfall finder responses.
GET
waterfall_get_company_enrichment
Retrieve Waterfall company enrichment job state and output by job ID.

/v1/enrichment/company

1 parameter
ParamTypeRequiredDescription
job_idstringrequiredThe Waterfall job ID returned by a launcher action.
POST
waterfall_check_job_change
Check whether a contact changed jobs using Waterfall job change detection.

/v1/job/change

7 parameters
ParamTypeRequiredDescription
company_domainstringoptionalPrevious company domain for the contact.
company_linkedinstringoptionalPrevious company LinkedIn URL or slug.
contact_linkedinstringoptionalContact LinkedIn URL or slug.
professional_emailstringoptionalContact professional email address.
personal_emailstringoptionalContact personal email address.
contact_full_namestringoptionalFull name of the contact.
custom_fieldsobjectoptionalCustom metadata to echo back in Waterfall finder responses.
GET
waterfall_get_account_usage
Get Waterfall usage metrics for the authenticated API key and full account.

/v2/account

1 parameter
ParamTypeRequiredDescription
monthstringoptionalOptional month in YYYY-MM format used to scope usage counters.