Skip to main content
Server path: /findymail | Type: Application | PCID required: Yes

Tools

ToolDescription
findymail_add_excluded_domainsAdd excluded domains
findymail_create_amonitorCreate a monitor
findymail_create_anew_exclusion_listCreate a new exclusion list
findymail_create_anew_listCreate a new list
findymail_delete_agiven_listDelete a given list
findymail_delete_amonitorDelete a monitor
findymail_delete_an_exclusion_listDelete an exclusion list
findymail_find_employeesFind employees
findymail_find_from_business_profileFind from business profile
findymail_find_from_domainFind from domain
findymail_find_from_nameFind from name
findymail_find_phoneFind phone
findymail_get_all_exclusion_listsGet all exclusion lists
findymail_get_asignalGet a signal
findymail_get_company_informationGet company information
findymail_get_contacts_savedGet contacts saved
findymail_get_excluded_domainsGet excluded domains
findymail_get_exclusion_list_detailsGet exclusion list details
findymail_get_export_statusGet export status
findymail_get_remaining_creditsGet remaining credits
findymail_get_resultsGet results
findymail_get_team_usageGet team usage
findymail_get_the_list_of_contact_listsGet the list of contact lists
findymail_get_usageGet usage
findymail_list_monitorsList monitors
findymail_list_signalsList signals
findymail_lookup_reverse_emailReverse email lookup
findymail_remove_excluded_domainsRemove excluded domains
findymail_search_leadsSearch leads
findymail_search_lookalike_companiesSearch lookalike companies
findymail_update_acontact_listUpdate a contact list
findymail_update_amonitorUpdate a monitor
findymail_update_an_exclusion_listUpdate an exclusion list
findymail_verify_an_emailVerify an email

findymail_add_excluded_domains

Add excluded domains Parameters:
ParameterTypeRequiredDefaultDescription
domainsany[]YesArray of domain names to exclude (max 10000).
list_idintegerNoOptional list ID to add domains to. If not provided, domains are added as global exclusions.

findymail_create_amonitor

Create a monitor Parameters:
ParameterTypeRequiredDefaultDescription
engagement_typesany[]NoEngagement types to track (required for post_engagement). Accepted values: like, comment.
enrichment_levelstringNoContact enrichment level. Accepted values: email, email_phone.
icp_filtersobjectNoOptional ICP filter criteria to narrow signal matching.
keywordsany[]NoKeywords to track (required for keyword_mention and post_engagement without post_url, max 5).
lead_list_idintegerNoID of a lead list to automatically add matched contacts to.
namestringYesThe monitor name.
post_urlstringNoLinkedIn post URL to monitor engagement on (for post_engagement type).
signal_typestringYesThe signal type. Accepted values: keyword_mention, new_hire, job_change, post_engagement. IMPORTANT: Additional fields are required depending on signal_type: (1) keyword_mention requires keywords. (2) post_engagement requires engagement_types AND either post_url or keywords. Omitting these conditionally-required fields will cause a server-side validation error.
webhook_urlstringNoOptional HTTPS URL to receive webhook notifications when new signals match.

findymail_create_anew_exclusion_list

Create a new exclusion list Parameters:
ParameterTypeRequiredDefaultDescription
is_sharedbooleanNoWhether to share the list with the current team.
namestringYesThe name of the list (must be unique per user).

findymail_create_anew_list

Create a new list Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesName of the list

findymail_delete_agiven_list

Delete a given list Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the list.

findymail_delete_amonitor

Delete a monitor Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the monitor.

findymail_delete_an_exclusion_list

Delete an exclusion list Parameters:
ParameterTypeRequiredDefaultDescription
excludedDomainList_idintegerYesThe ID of the excludedDomainList.

findymail_find_employees

Find employees Parameters:
ParameterTypeRequiredDefaultDescription
countintegerNoNumber of contacts to return (max 5). Default 1.
job_titlesany[]Yestarget job titles (max 10)
websitestringYescompany website

findymail_find_from_business_profile

Find from business profile Parameters:
ParameterTypeRequiredDefaultDescription
linkedin_urlstringYesPerson’s business profile URL. (can be full URL “https://linkedin.com/in/johndoe” or username only “johndoe”)
webhook_urlstringNoWebhook URL that will receive the result as callback. If submitted, email search will happen in the background and notify this URL upon completion.

findymail_find_from_domain

Find from domain Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesEmail domain
rolesany[]YesTarget roles related to the given domain (max 3 roles)
webhook_urlstringNoWebhook URL that will receive the result as callback. If submitted, search will happen in the background and notify this URL upon completion.

findymail_find_from_name

Find from name Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesCompany domain (best) or company name
namestringYesPerson’s full name
webhook_urlstringNoWebhook URL that will receive the result as callback. If submitted, email search will happen in the background and notify this URL upon completion.

findymail_find_phone

Find phone Parameters:
ParameterTypeRequiredDefaultDescription
linkedin_urlstringYesPerson’s business profile URL. (can be full URL “https://linkedin.com/in/johndoe” or username only “johndoe”)

findymail_get_all_exclusion_lists

Get all exclusion lists

findymail_get_asignal

Get a signal Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the signal.

findymail_get_company_information

Get company information Parameters:
ParameterTypeRequiredDefaultDescription
domainstringNoCompany domain
linkedin_urlstringNoCompany LinkedIn URL
namestringNoCompany name

findymail_get_contacts_saved

Get contacts saved Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesOptional parameter. Get contacts from a specified list. If 0, no list used (“All contacts”).

findymail_get_excluded_domains

Get excluded domains Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoSearch query to filter domains.
list_idintegerNoFilter domains by list ID.
per_pageintegerNoNumber of domains per page.
pageintegerNoPage number.

findymail_get_exclusion_list_details

Get exclusion list details Parameters:
ParameterTypeRequiredDefaultDescription
excludedDomainList_idintegerYesThe ID of the excludedDomainList.

findymail_get_export_status

Get export status Parameters:
ParameterTypeRequiredDefaultDescription
hashstringYesThe export hash returned by the search endpoint.

findymail_get_remaining_credits

Get remaining credits

findymail_get_results

Get results Parameters:
ParameterTypeRequiredDefaultDescription
hashstringYesThe hash returned by the search endpoint.
pageintegerNoThe page number (default: 1).
per_pageintegerNoResults per page (max: 500, default: 100).

findymail_get_team_usage

Get team usage Parameters:
ParameterTypeRequiredDefaultDescription
fromstringNooptional The start date (incl.) for the report (YYYY-MM-DD format). Defaults to 30 days ago.
tostringNooptional The end date (incl.) for the report (YYYY-MM-DD format). Defaults to today.

findymail_get_the_list_of_contact_lists

Get the list of contact lists

findymail_get_usage

Get usage Parameters:
ParameterTypeRequiredDefaultDescription
fromstringNooptional The start date (incl.) for the timeline (YYYY-MM-DD format). Defaults to 30 days ago.
tostringNooptional The end date (incl.) for the timeline (YYYY-MM-DD format). Defaults to today.

findymail_list_monitors

List monitors

findymail_list_signals

List signals Parameters:
ParameterTypeRequiredDefaultDescription
signal_typestringNoFilter by signal type. Accepted values: keyword_mention, new_hire, job_change, post_engagement.
monitor_idintegerNoFilter by a specific monitor ID (must be owned by the authenticated user).
date_fromstringNoFilter signals detected on or after this date (format: YYYY-MM-DD).
date_tostringNoFilter signals detected on or before this date (format: YYYY-MM-DD).
relevance_scoresstringNoComma-separated AI relevance scores to include (0-5). Optionally combine with monitor_id to scope to a single monitor.
pageintegerNoThe page number (default: 1).
per_pageintegerNoResults per page (max: 100, default: 50).

findymail_lookup_reverse_email

Reverse email lookup Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesEmail address to lookup
with_profilebooleanNooptional Whether to return profile metadata (default: false)

findymail_remove_excluded_domains

Remove excluded domains Parameters:
ParameterTypeRequiredDefaultDescription
idsany[]YesArray of domain IDs to delete.

findymail_search_leads

Search leads Parameters:
ParameterTypeRequiredDefaultDescription
configobjectNoExport configuration (all fields are optional).
limitintegerNoThe maximum number of companies to export (default: 100, max: 5000).
querystringYesThe search query describing target companies.

findymail_search_lookalike_companies

Search lookalike companies Parameters:
ParameterTypeRequiredDefaultDescription
exclusion_list_idsany[]NoIDs of exclusion lists to filter out already-known companies.
limitintegerNoMaximum number of companies to return (default: 100, max: 10000).
same_countrybooleanNoOnly return companies in the same country as the seed (default: false).
same_sizebooleanNoOnly return companies in the same size range as the seed (default: false).
seedstringYesThe seed company domain or URL.

findymail_update_acontact_list

Update a contact list Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the list.
isSharedbooleanYesEnable/disable list sharing with the team
namestringYesNew name of the list

findymail_update_amonitor

Update a monitor Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the monitor.
engagement_typesany[]NoEngagement types to track (required for post_engagement). Accepted values: like, comment.
enrichment_levelstringNoContact enrichment level. Accepted values: email, email_phone.
icp_filtersobjectNoOptional ICP filter criteria.
keywordsany[]NoKeywords to track (required for keyword_mention, nullable otherwise, max 5).
lead_list_idintegerNoID of a lead list to automatically add matched contacts to.
namestringYesThe monitor name.
webhook_urlstringNoOptional HTTPS URL to receive webhook notifications.

findymail_update_an_exclusion_list

Update an exclusion list Parameters:
ParameterTypeRequiredDefaultDescription
excludedDomainList_idintegerYesThe ID of the excludedDomainList.
is_sharedbooleanNoOptional. Set to true to share with team, false to make private.
namestringYesThe new name for the list (must be unique per user).

findymail_verify_an_email

Verify an email Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesEmail to verify