HeyReach API icon

HeyReach API

Interact with HeyReach API
Join our community

Actions33

Overview

The node interacts with the HeyReach API to retrieve multiple list records based on specified criteria. It supports pagination through offset and limit parameters, allowing users to fetch subsets of lists efficiently. Additional filtering options enable narrowing down results by keyword search, associated campaign IDs, or list type (user or company lists).

This node is beneficial in scenarios where you need to manage or analyze large sets of contact or company lists from HeyReach, such as syncing lists for marketing campaigns, reporting, or data enrichment workflows.

Example use cases:

  • Fetching the first 50 user lists related to specific campaigns for targeted outreach.
  • Searching for company lists containing a particular keyword in their name.
  • Paginating through all available lists to export or synchronize them with another system.

Properties

Name Meaning
Offset Number of records to skip for pagination. Defaults to 0.
Limit Maximum number of records to return. Maximum allowed is 100. Defaults to 10.
Additional Fields Collection of optional filters:
- Keyword Search keyword to filter lists by name.
- Campaign IDs Array of campaign IDs to filter lists associated with specific campaigns (e.g., [123, 456]).
- List Type The type of list to retrieve. Options: User List, Company List.

Output

The node outputs an array of list objects in the json output field. Each object represents a list retrieved from HeyReach, containing details such as list identifiers, names, types, and possibly associated campaign information depending on the API response.

If binary data were involved (not indicated here), it would typically represent attachments or files related to the lists, but this node focuses on JSON data only.

Dependencies

  • Requires an active connection to the HeyReach API via an API key credential configured in n8n.
  • Network access to https://api.heyreach.io/api/n8n.
  • Proper permissions on the HeyReach account to read list data.

Troubleshooting

  • Common issues:

    • Pagination errors if offset or limit values are out of range or invalid.
    • Empty results when filters do not match any lists.
    • Authentication failures due to missing or invalid API credentials.

  • Error messages:

    • Unauthorized / 401: Check that the API key credential is correctly set up and has necessary permissions.
    • Bad Request / 400: Verify that numeric inputs like offset and limit are within valid ranges and that filters are formatted correctly.
    • Rate Limit Exceeded: Reduce request frequency or check HeyReach API usage limits.

Links and References

Discussion