Skip to main content
Findymail logo
  • Category: people & contact data
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 21
  • Triggers: 0
  • Slug: FINDYMAIL
  • Version: 20261101_00

Tools

Slug: FINDYMAIL_ADD_EXCLUDED_DOMAINAdd domains to Findymail exclusions used by Intellimatch searches. Without a list identifier, domains are added as global exclusions. For batches over 50 domains, the first 50 are processed immediately and the rest are queued; up to 10,000 domains can be submitted.

Input Parameters

array
required
Array of domain names to add to the exclusion list
integer
ID of the exclusion list to add domains to. If not provided, domains will be added to the default list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_CREATE_EXCLUSION_LISTCreate a named exclusion list for the authenticated user to organize websites excluded from Intellimatch searches. The list name must be unique per user.

Input Parameters

string
required
Name of the exclusion list to create

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_CREATE_LISTTool to create a new contact list. Use when you need to organize contacts into a named list before adding them.

Input Parameters

string
required
Name of the new contact list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_DELETE_EXCLUSION_LISTDelete an Intellimatch exclusion list by ID and all its associated domains. Only the list owner can delete it; the action is irreversible.

Input Parameters

integer
required
The unique numeric identifier of the exclusion list to delete. This action is irreversible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_DELETE_LISTPermanently deletes a contact list by its ID. This action is irreversible and will also remove all contacts in the list. Returns 404 if the list does not exist.

Input Parameters

integer
required
The unique numeric identifier of the contact list to delete. Obtain this from FINDYMAIL_GET_CONTACT_LISTS or FINDYMAIL_CREATE_LIST.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_FIND_EMAIL_BY_NAMEFind a person’s email using their full name and company domain or company name. Supply a webhook URL to run the search asynchronously and receive the result by callback.

Input Parameters

string
required
Person’s full name
string
required
Email domain (best) or company name
string
Webhook URL that will receive the result as callback. If provided, endpoint will process asynchronously.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_GET_CONTACT_LISTSTool to retrieve all contact lists. Use when you need an overview of your existing Findymail lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_GET_CREDITSCheck the team’s remaining Findymail credit balance before running operations. On usage-based plans, the response indicates whether the team still has capacity to run requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_GET_CREDITS_SUMMARYTool to retrieve credits usage summary report for the authenticated account. Use when you need to check credits consumption over time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_GET_CREDITS_TEAM_SUMMARYRetrieve the team’s credit usage summary for the default reporting period, including totals and usage by team member. Only the team owner can access this report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_GET_EXCLUSION_LISTRetrieve metadata for an exclusion list by ID, without its domains. The list must be owned by the user or shared with their team.

Input Parameters

string
required
Unique identifier of the exclusion list to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_GET_INTELLIMATCH_DATARetrieve the default first page of company data from a completed Intellimatch search by hash. The response exposes selected company fields and pagination metadata, not contact details.

Input Parameters

string
required
The hash/search ID returned from the POST /api/intellimatch/search endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_GET_INTELLIMATCH_STATUSTool to check the status of an Intellimatch search job. Use when you need to verify if an Intellimatch search has completed after initiating it.

Input Parameters

string
required
The hash identifier of the Intellimatch search job (returned from POST /api/intellimatch/search)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_LIST_CONTACTSTool to retrieve contacts from a specified list (paginated). Use after selecting a list to fetch its contacts.

Input Parameters

integer
required
The ID of the contact list. Use 0 for “All contacts”.
integer
The offset (starting record index) for pagination. Defaults to 0.
integer
Number of records to return per page. Defaults to 10, max 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_LIST_EXCLUDED_DOMAINSRetrieve a page of globally excluded domains for Intellimatch searches.

Input Parameters

integer
Page number for paginated results (starts at 1). Defaults to 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_LIST_EXCLUSION_LISTSTool to retrieve all exclusion lists for managing excluded websites from Intellimatch searches. Use when you need to view configured website exclusions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_REMOVE_EXCLUDED_DOMAINRemove excluded domains by ID from Intellimatch exclusion lists. Only domains the user has permission to delete are removed.

Input Parameters

array
required
Array of domain IDs to remove from the exclusion list. Domain IDs can be obtained from the GET /api/intellimatch/domains endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_SEARCH_INTELLIMATCHStart an Intellimatch company search using a natural-language query, optionally finding contacts and emails. The search returns a task hash for tracking progress and retrieving results, helping build targeted lead lists.

Input Parameters

integer
Maximum number of results to return. If not specified, the API default will be used.
string
required
Natural language query describing the companies or contacts you’re looking for (e.g., ‘SaaS companies in San Francisco’, ‘CTOs at fintech startups in New York’).
object
Configuration options for Intellimatch search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_UPDATE_EXCLUSION_LISTRename an existing exclusion list. Only the list owner can update it.

Input Parameters

string
required
The new name for the exclusion list
string
required
The unique identifier of the exclusion list to update. Obtain this from listing exclusion lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_UPDATE_LISTUpdate an existing Findymail contact list’s name and team-sharing setting. Provide the list ID and both the updated name and sharing value.

Input Parameters

integer
required
The unique numeric identifier of the contact list to update. Obtain this from FINDYMAIL_GET_CONTACT_LISTS or FINDYMAIL_CREATE_LIST.
string
required
Updated name for the contact list
boolean
required
Whether the list is shared with team members

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINDYMAIL_VERIFY_EMAILVerify the deliverability of an email address before outreach. The result indicates whether the address is verified and may include its email provider.

Input Parameters

string
required
The email address to be verified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not