Instantly icon

Instantly

Interact with Instantly API

Actions28

Lead → Get Many

AI-generated

Overview

This node operation retrieves multiple lead records from the Instantly API based on specified filters and pagination options. It is useful for scenarios where you need to fetch a list of leads for analysis, reporting, or further processing in workflows. For example, you can get all leads that match certain criteria like campaign membership, contact status, or email service provider code, either returning all results or limiting the number of leads returned.

Use Case Examples

  1. Fetch all leads that are marked as 'Interested' in a specific campaign.
  2. Retrieve up to 50 leads that have not been contacted yet.
  3. Search leads by first name, last name, or email with a specific filter applied.

Properties

Name Meaning
Return All Whether to return all lead results or only up to a given limit.
Limit Maximum number of lead results to return when 'Return All' is false. Value ranges from 1 to 100.
Filters Collection of filter criteria to narrow down the leads retrieved, including search text, lead status filters, campaign filtering, campaign membership, and ESP code filtering.

Output

JSON

  • id - Unique identifier of the lead.
  • first_name - First name of the lead.
  • last_name - Last name of the lead.
  • email - Email address of the lead.
  • status - Status of the lead based on applied filters.
  • campaign_id - Identifier of the campaign the lead belongs to, if any.

Dependencies

  • Instantly API with API key credential

Troubleshooting

  • Common issues include API request failures due to invalid credentials or network issues. Ensure the API key credential is correctly configured.
  • If no leads are returned, verify that the filter criteria are correct and that leads matching those criteria exist in the Instantly account.
  • Error messages related to invalid campaign IDs or filter values indicate incorrect input parameters; validate inputs before execution.

Discussion