Instantly icon

Instantly

Interact with Instantly API

Actions15

Overview

This node interacts with the Instantly API to retrieve multiple leads based on various filtering criteria. The "Get Many" operation for the "Lead" resource allows users to fetch a list of leads, optionally filtered by search terms, campaign membership, lead status, and email service provider codes. It supports pagination internally but can return either all matching leads or limit the number of results.

Common scenarios where this node is beneficial include:

  • Exporting or syncing lead data from Instantly into other systems.
  • Filtering leads by campaign or status to target specific segments.
  • Automating workflows that depend on lead attributes such as contact status or interest level.

Practical example:

  • A marketing automation workflow that retrieves all leads marked as "Interested" in a particular campaign to send them a personalized follow-up email.

Properties

Name Meaning
Return All Whether to return all matching leads or only up to a specified limit.
Limit Maximum number of leads to return when "Return All" is false. Must be between 1 and 100.
Filters Collection of filters to narrow down the leads:
- Search Text to search leads by first name, last name, or email.
- Filter Predefined filter criteria for leads. Options include: All, Contacted, Not Contacted, Completed, Unsubscribed, Active, Interested, Not Interested, Meeting Booked, Meeting Completed, Closed.
- Campaign Filter leads by campaign. Can select from a list of campaigns or specify a campaign ID.
- In Campaign Boolean indicating whether to filter leads that are in (true) or not in (false) the specified campaign.
- ESP Code Filter leads by Email Service Provider code. Options include: All, In Queue, Google, Microsoft, Zoho, Yahoo, Yandex, Web.de, Libero.it, Other, Not Found.

Output

The node outputs an array of JSON objects representing leads. Each object corresponds to a lead retrieved from the Instantly API and contains lead details such as first name, last name, email, status, campaign membership, and other relevant fields as provided by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Instantly API.
  • The node uses the Instantly API endpoints /api/v2/leads/list to fetch leads.
  • Pagination is handled internally by repeatedly calling the API with cursor parameters until all requested leads are retrieved or the limit is reached.
  • No additional external dependencies beyond the Instantly API and n8n's HTTP request capabilities.

Troubleshooting

  • Limit Exceeded Error: If the "Limit" property is set above 100, the node will throw an error because the Instantly API enforces a maximum limit of 100 per request. To resolve, reduce the limit to 100 or enable "Return All" to fetch all leads via pagination.
  • Empty Results: If no leads match the filter criteria, the output will be an empty array. Verify filter values and campaign IDs are correct.
  • Invalid Campaign ID: When filtering by campaign using an ID, ensure the ID matches the UUID format; otherwise, the API may reject the request.
  • API Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access lead data.
  • Pagination Limits: The node limits pagination to 1000 pages to prevent infinite loops. If you have extremely large datasets, consider refining filters or retrieving data in smaller batches.

Links and References

Discussion