NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Icypeas connects to a Nagent workspace with an API key. Once it is connected, agents can call 22 Icypeas actions, such as "Find Profile URLs Bulk", "Find Companies" and "Find Company URL". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Icypeas, with input parameters and output schema.
ICYPEAS_BULK_EMAIL_SEARCHInitiate a bulk email search job to find professional email addresses for multiple people at once. Use this tool when you need to find emails for more than one person. Provide names (first and/or last) along with company domains or names. The API queues the job and returns a file identifier that can be used with 'Fetch Bulk Search Info' and 'Retrieve Search Results' to check progress and get results. Rate limit: 1 request per second. Maximum 5000 rows per bulk request.
Input parameters
List of rows to search. Each row is a 3-element array: \[firstname, lastname, domainOrCompany\]. At least one of firstname or lastname must be provided (the other can be null). domainOrCompany can be either a domain (e.g., 'google.com') or company name (e.g., 'Google Inc'). Maximum 5000 rows per request.
A descriptive name for this bulk search job. Used to identify the job in the Icypeas dashboard and API responses.
Task type. Must be 'email-search' for bulk email lookups.
Extra options for webhook callbacks and tracking per row.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_BULK_FIND_PROFILE_URLSTool to perform bulk search for profile URLs based on firstname, lastname, and company/domain or job title. Use when you need to find LinkedIn or other social profile URLs for multiple prospects at once (up to 50 per request). This endpoint returns immediate results with profile URLs. Each result includes the found URL (or empty string if not found), a search ID, and a status indicator.
Input parameters
List of profiles to search. Maximum 50 items per request.
Type of bulk URL search. Must be 'profile' for profile URL search.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_BULK_REVERSE_EMAIL_LOOKUPTool to find LinkedIn profile URLs for multiple professional email addresses in a single request. Use when you need to reverse lookup 2-50 email addresses to find their associated LinkedIn profiles. Each lookup costs 10 credits per found profile. Returns results immediately (not async like other bulk operations).
Input parameters
Array of professional email addresses to look up. Minimum 2 addresses, maximum 50 addresses per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_BULK_SCRAPETool to scrape multiple LinkedIn profiles or companies in bulk (up to 50 per request). Use when you need to scrape multiple LinkedIn URLs at once. Returns a job ID that can be used with check_progress to fetch results.
Input parameters
Array of LinkedIn URLs to scrape. Maximum 50 URLs per request. For profiles: use LinkedIn profile URLs (e.g., https://www.linkedin.com/in/username). For companies: use LinkedIn company URLs (e.g., https://www.linkedin.com/company/companyname).
The type of data to scrape. Use 'profile' for LinkedIn profiles or 'company' for LinkedIn companies.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_CHECK_PROGRESSCheck the processing progress of a search by its ID. Use this tool after initiating a single or bulk search to monitor its status. For mode='single': Checks progress of individual search items via /bulk-single-searchs/read endpoint. For mode='bulk': Checks progress of bulk search files via /search-files/read endpoint. Poll this endpoint periodically until 'finished' is True or item status is 'DEBITED'. Note: ICYPEAS recommends using webhooks instead of polling for production use.
Input parameters
The ID to check: for mode='single', the search item ID (_id); for mode='bulk', the bulk file ID.
Mode of progress check: 'single' for individual search items, 'bulk' for bulk file progress.
Pagination direction: true to fetch the next page, false to fetch the previous page.
(mode='single' only) Filter results by task type.
Maximum number of records to fetch per page. For single mode: max 100, default 10. For bulk mode: max 50, default 10.
Pagination cursor from a previous response. Required when navigating to next/previous pages.
(mode='bulk' only) Filter bulk files by processing status.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_COUNT_COMPANIESTool to count companies in Icypeas database matching specified filters without returning data or being charged. Use when you need to know how many companies match specific criteria like industry, location, or headcount.
Input parameters
Search filters object containing various field filters.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_COUNT_PEOPLETool to count people matching specified filters without retrieving data or consuming credits. Use when you need to assess the size of a people search result set before running the actual query.
Input parameters
Search filters: include/exclude lists per field.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_DOMAIN_SCANTool to scan a domain for role-based email addresses. Use when you need to discover all role-based emails for a specific domain.
Input parameters
Optional customization parameters for the scan
The domain or company name to scan for role-based email addresses
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_FETCH_BULK_SEARCH_INFORetrieve bulk search files with their status and progress. Lists all bulk searches (email, profile, company searches) with pagination support. Use to monitor bulk operation progress, check completion status, or retrieve file IDs for further operations.
Input parameters
Filter results to a specific bulk search file by its unique ID. If provided, only that file's details are returned.
Pagination direction when using 'sorts' cursor. Set to true to get the next page, false for previous page. Requires 'sorts' to be provided.
Maximum number of bulk search files to return per page. Default is 10, maximum is 50.
Pagination cursor obtained from the 'sorts' field of a previous response. Use with 'next_page' to navigate through results.
Filter by search status. Use 'in_progress' for running searches or 'done' for completed searches.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_FETCH_SUBSCRIPTION_INFORetrieves subscription details and remaining credits for an Icypeas account. Use this to check credit balances, subscription status, and user ID before performing searches. The email parameter must match the account owner's email associated with the API key.
Input parameters
The email address of the Icypeas account owner. This must be the same email associated with the API key being used for authentication.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_FIND_COMPANIESTool to search companies in Icypeas database. Use when you need to find companies matching filters like industry, location, or headcount.
Input parameters
Search filters object containing various field filters.
Pagination parameters for retrieving additional pages of results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_FIND_COMPANY_URLTool to find a single company profile URL using a company name or domain. Use when you need to initiate a profile-URL search for a given company identifier.
Input parameters
Either the full company name or its website domain.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_FIND_LINKEDIN_PROFILE_BY_EMAILFind the LinkedIn profile URL behind a single professional email address. Use when you need to identify the person associated with an email address. Costs 10 credits per found profile.
Input parameters
A professional email address to look up (e.g., 'john.doe@company.com')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_FIND_PEOPLESearch for people/leads in the Icypeas database. Supports filtering by name, job title, company, location, skills, languages, school, and keywords. Each filter supports include/exclude lists. Returns matching leads with pagination support for large result sets. Requires credits to execute.
Input parameters
Search filters: include/exclude lists per field.
Pagination settings for multi-page results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_FIND_PROFILE_URLFinds a person's LinkedIn profile URL using their name and company or job title. Use this tool when you need to find someone's LinkedIn profile URL. Provide the person's first name, last name, and either their company/domain OR job title. Tips for best results: - For company/domain, use the website domain (e.g., 'icypeas.com') or company name - Keep inputs simple - avoid over-specifying details - Costs 1 credit per successful search Example: Find LinkedIn URL for Pierre Landoin at icypeas.com
Input parameters
Job title of the person to help identify the correct profile (e.g., 'CEO', 'Software Engineer'). Required if companyOrDomain is not provided.
Last name of the person to search for (e.g., 'Landoin')
First name of the person to search for (e.g., 'Pierre')
Company name or website domain to narrow the search (e.g., 'icypeas.com' or 'Icypeas'). Required if jobTitle is not provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_FIND_SINGLE_EMAILInitiates an asynchronous email search to find a prospect's email address using their name and company. Returns a search item ID that can be used with ICYPEAS_RETRIEVE_SEARCH_RESULTS to get the actual email. Use for individual lookups; for bulk operations, use ICYPEAS_BULK_EMAIL_SEARCH instead.
Input parameters
Optional container for webhook and external tracking data.
Prospect’s last name; required if firstname is omitted
Prospect’s first name; required if lastname is omitted
The person’s company domain or company name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_PARSE_BULK_SEARCH_STATISTICSTool to parse bulk search statistics webhook. Use when processing the completion notification of a bulk search.
Input parameters
Bulk search summary and details
HMAC-SHA1 signature of the payload
ISO 8601 timestamp used to compute signature
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_RETRIEVE_SEARCH_RESULTSTool to retrieve the results of a search by ID or to paginate through bulk search results. Use after initiating a search to fetch individual or multiple search results.
Input parameters
_id of the single result (required if mode='single')
Bulk-file identifier (required if mode='bulk')
Choose 'single' for one item or 'bulk' for bulk-file search
Pagination direction: true for next page, false for previous
Task filter for single-mode only (not allowed when mode='bulk')
Number of results per page (default 10, max 100)
Pagination cursor from previous response
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_SCRAPE_COMPANYTool to initiate scraping of a LinkedIn company page. Use when you have a LinkedIn company URL and need to retrieve company profile data. Returns a job ID that can be used with check_progress to fetch the full results.
Input parameters
LinkedIn company profile URL to scrape. Must be a valid LinkedIn company URL (e.g., https://www.linkedin.com/company/microsoft).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_SCRAPE_PROFILETool to initiate scraping of a LinkedIn profile. Use when you have a public LinkedIn profile URL and need a job ID and status to later fetch full details.
Input parameters
LinkedIn profile URL to scrape. Must be a valid LinkedIn profile URL (e.g., https://www.linkedin.com/in/username).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_SETUP_NOTIFICATIONSProvides instructions for setting up Icypeas push notifications/webhooks. Use this tool when you need to configure real-time notifications for bulk searches or single search updates. Note: Webhooks must be configured via the Icypeas dashboard; there is no API endpoint for programmatic setup.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ICYPEAS_VERIFY_EMAILTool to verify if a specific email address exists and is valid. Use when you need to check email deliverability. Returns a verification item ID that can be used with ICYPEAS_RETRIEVE_SEARCH_RESULTS to get the verification result.
Input parameters
The email address to verify
Optional container for webhook and external tracking data.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 22 Icypeas actions on Nagent, including "Find Profile URLs Bulk", "Find Companies" and "Find Company URL". Find Profile URLs Bulk: Perform bulk search for profile URLs based on firstname, lastname, and company/domain or job title. Each action is listed on this page with its input parameters and its output.
Icypeas connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Find Profile URLs Bulk takes 1 required input: data. It also takes 1 optional input: type. It returns data, error and successful.