/findymail | Type: Application | PCID required: Yes
Tools
findymail_add_excluded_domains
Add excluded domains Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domains | any[] | Yes | — | Array of domain names to exclude (max 10000). |
list_id | integer | No | — | Optional list ID to add domains to. If not provided, domains are added as global exclusions. |
findymail_create_amonitor
Create a monitor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
engagement_types | any[] | No | — | Engagement types to track (required for post_engagement). Accepted values: like, comment. |
enrichment_level | string | No | — | Contact enrichment level. Accepted values: email, email_phone. |
icp_filters | object | No | — | Optional ICP filter criteria to narrow signal matching. |
keywords | any[] | No | — | Keywords to track (required for keyword_mention and post_engagement without post_url, max 5). |
lead_list_id | integer | No | — | ID of a lead list to automatically add matched contacts to. |
name | string | Yes | — | The monitor name. |
post_url | string | No | — | LinkedIn post URL to monitor engagement on (for post_engagement type). |
signal_type | string | Yes | — | The 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_url | string | No | — | Optional HTTPS URL to receive webhook notifications when new signals match. |
findymail_create_anew_exclusion_list
Create a new exclusion list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
is_shared | boolean | No | — | Whether to share the list with the current team. |
name | string | Yes | — | The name of the list (must be unique per user). |
findymail_create_anew_list
Create a new list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Name of the list |
findymail_delete_agiven_list
Delete a given list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the list. |
findymail_delete_amonitor
Delete a monitor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the monitor. |
findymail_delete_an_exclusion_list
Delete an exclusion list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
excludedDomainList_id | integer | Yes | — | The ID of the excludedDomainList. |
findymail_find_employees
Find employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
count | integer | No | — | Number of contacts to return (max 5). Default 1. |
job_titles | any[] | Yes | — | target job titles (max 10) |
website | string | Yes | — | company website |
findymail_find_from_business_profile
Find from business profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
linkedin_url | string | Yes | — | Person’s business profile URL. (can be full URL “https://linkedin.com/in/johndoe” or username only “johndoe”) |
webhook_url | string | No | — | Webhook 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domain | string | Yes | — | Email domain |
roles | any[] | Yes | — | Target roles related to the given domain (max 3 roles) |
webhook_url | string | No | — | Webhook 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domain | string | Yes | — | Company domain (best) or company name |
name | string | Yes | — | Person’s full name |
webhook_url | string | No | — | Webhook 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
linkedin_url | string | Yes | — | Person’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 listsfindymail_get_asignal
Get a signal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the signal. |
findymail_get_company_information
Get company information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domain | string | No | — | Company domain |
linkedin_url | string | No | — | Company LinkedIn URL |
name | string | No | — | Company name |
findymail_get_contacts_saved
Get contacts saved Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Optional parameter. Get contacts from a specified list. If 0, no list used (“All contacts”). |
findymail_get_excluded_domains
Get excluded domains Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | Search query to filter domains. |
list_id | integer | No | — | Filter domains by list ID. |
per_page | integer | No | — | Number of domains per page. |
page | integer | No | — | Page number. |
findymail_get_exclusion_list_details
Get exclusion list details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
excludedDomainList_id | integer | Yes | — | The ID of the excludedDomainList. |
findymail_get_export_status
Get export status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
hash | string | Yes | — | The export hash returned by the search endpoint. |
findymail_get_remaining_credits
Get remaining creditsfindymail_get_results
Get results Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
hash | string | Yes | — | The hash returned by the search endpoint. |
page | integer | No | — | The page number (default: 1). |
per_page | integer | No | — | Results per page (max: 500, default: 100). |
findymail_get_team_usage
Get team usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | optional The start date (incl.) for the report (YYYY-MM-DD format). Defaults to 30 days ago. |
to | string | No | — | optional 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 listsfindymail_get_usage
Get usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | optional The start date (incl.) for the timeline (YYYY-MM-DD format). Defaults to 30 days ago. |
to | string | No | — | optional The end date (incl.) for the timeline (YYYY-MM-DD format). Defaults to today. |
findymail_list_monitors
List monitorsfindymail_list_signals
List signals Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
signal_type | string | No | — | Filter by signal type. Accepted values: keyword_mention, new_hire, job_change, post_engagement. |
monitor_id | integer | No | — | Filter by a specific monitor ID (must be owned by the authenticated user). |
date_from | string | No | — | Filter signals detected on or after this date (format: YYYY-MM-DD). |
date_to | string | No | — | Filter signals detected on or before this date (format: YYYY-MM-DD). |
relevance_scores | string | No | — | Comma-separated AI relevance scores to include (0-5). Optionally combine with monitor_id to scope to a single monitor. |
page | integer | No | — | The page number (default: 1). |
per_page | integer | No | — | Results per page (max: 100, default: 50). |
findymail_lookup_reverse_email
Reverse email lookup Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | Email address to lookup |
with_profile | boolean | No | — | optional Whether to return profile metadata (default: false) |
findymail_remove_excluded_domains
Remove excluded domains Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | any[] | Yes | — | Array of domain IDs to delete. |
findymail_search_leads
Search leads Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | object | No | — | Export configuration (all fields are optional). |
limit | integer | No | — | The maximum number of companies to export (default: 100, max: 5000). |
query | string | Yes | — | The search query describing target companies. |
findymail_search_lookalike_companies
Search lookalike companies Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
exclusion_list_ids | any[] | No | — | IDs of exclusion lists to filter out already-known companies. |
limit | integer | No | — | Maximum number of companies to return (default: 100, max: 10000). |
same_country | boolean | No | — | Only return companies in the same country as the seed (default: false). |
same_size | boolean | No | — | Only return companies in the same size range as the seed (default: false). |
seed | string | Yes | — | The seed company domain or URL. |
findymail_update_acontact_list
Update a contact list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the list. |
isShared | boolean | Yes | — | Enable/disable list sharing with the team |
name | string | Yes | — | New name of the list |
findymail_update_amonitor
Update a monitor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the monitor. |
engagement_types | any[] | No | — | Engagement types to track (required for post_engagement). Accepted values: like, comment. |
enrichment_level | string | No | — | Contact enrichment level. Accepted values: email, email_phone. |
icp_filters | object | No | — | Optional ICP filter criteria. |
keywords | any[] | No | — | Keywords to track (required for keyword_mention, nullable otherwise, max 5). |
lead_list_id | integer | No | — | ID of a lead list to automatically add matched contacts to. |
name | string | Yes | — | The monitor name. |
webhook_url | string | No | — | Optional HTTPS URL to receive webhook notifications. |
findymail_update_an_exclusion_list
Update an exclusion list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
excludedDomainList_id | integer | Yes | — | The ID of the excludedDomainList. |
is_shared | boolean | No | — | Optional. Set to true to share with team, false to make private. |
name | string | Yes | — | The new name for the list (must be unique per user). |
findymail_verify_an_email
Verify an email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | Email to verify |

