HeyReach API icon

HeyReach API

Interact with HeyReach API
Join our community

Actions33

Overview

This node interacts with the HeyReach API to retrieve leads from a specified lead list. It is designed to fetch lead data with support for pagination and filtering based on creation date, keywords, LinkedIn ID, or profile URL. This functionality is useful in scenarios where users want to analyze, export, or process leads collected in HeyReach lists, such as marketing campaigns, sales prospecting, or CRM enrichment.

For example, a user might use this node to:

  • Retrieve the first 100 leads created after a certain date from a specific list.
  • Search for leads containing a keyword in their name or other fields.
  • Fetch leads linked to a particular LinkedIn profile or LinkedIn ID.

Properties

Name Meaning
Offset Number of records to skip for pagination. Defaults to 0. Useful for paging through large sets of leads.
Limit Maximum number of records to return. Minimum 1, maximum 1000. Defaults to 100. Controls the batch size of retrieved leads.
List ID The numeric ID of the lead list from which to retrieve leads. This identifies the source list within HeyReach.
Additional Fields Optional filters to narrow down the leads returned:
• Created From: Only leads created on or after this timestamp.
• Created To: Only leads created before or at this timestamp.
• Keyword: Search term to filter leads by name or relevant fields.
• Lead LinkedIn ID: Filter by the LinkedIn ID of the lead.
• Lead Profile URL: Filter by full LinkedIn profile URL (must be in format https://www.linkedin.com/in/username/).

Output

The node outputs JSON data representing the leads retrieved from the specified list. Each item in the output corresponds to a lead record with its associated fields as provided by the HeyReach API. The structure typically includes lead details such as name, contact information, LinkedIn identifiers, creation timestamps, and any other metadata available.

If binary data were involved (e.g., files or images), it would be summarized here, but this node focuses on JSON lead data only.

Dependencies

  • Requires an active HeyReach API key credential configured in n8n to authenticate requests.
  • Depends on the HeyReach API endpoint https://api.heyreach.io/api/n8n.
  • No additional external services are required beyond HeyReach.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Providing an incorrect List ID may result in empty results or errors.
    • Exceeding the maximum limit (over 1000) will likely cause request failures.
    • Incorrectly formatted LinkedIn profile URLs in filters may yield no results.

  • Error messages:

    • Authentication errors: Check that the API key credential is correctly set up and valid.
    • Validation errors on parameters: Ensure numeric fields like Offset, Limit, and List ID are valid numbers within allowed ranges.
    • API rate limits or server errors: Retry after some time or check HeyReach service status.

Links and References

Discussion