HeyReach API icon

HeyReach API

Interact with HeyReach API
Join our community

Actions33

Overview

The "Get Lists" operation under the "List" resource in this HeyReach API node retrieves a paginated collection of lists associated with leads. This operation is useful when you want to fetch multiple lists, potentially filtered by lead-specific details such as email, LinkedIn ID, or LinkedIn profile URL. Typical use cases include managing marketing or outreach campaigns where you need to segment leads into different lists, or synchronizing lists from HeyReach into another system.

For example, you might use this operation to:

  • Retrieve the first 100 lists for a lead identified by their email address.
  • Paginate through all lists by adjusting the offset and limit parameters.
  • Filter lists by a lead’s LinkedIn profile URL to target specific professional segments.

Properties

Name Meaning
Offset Number of records to skip for pagination. Defaults to 0.
Limit Maximum number of records to return. Maximum allowed is 1000. Defaults to 100.
Additional Fields Optional filters to narrow down the lists by lead details:
- Email The email address of the lead to filter lists associated with that lead.
- Lead LinkedIn ID The LinkedIn ID of the lead, useful for filtering lists linked to a specific LinkedIn profile.
- Lead Profile URL The full LinkedIn profile URL of the lead, must be in the format https://www.linkedin.com/in/username/.

Output

The node outputs a JSON array containing the retrieved lists. Each list item typically includes metadata about the list such as its ID, name, and any other relevant attributes provided by the HeyReach API. The exact structure depends on the API response but generally represents a collection of list objects.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the HeyReach API via an API key credential.
  • The node expects the HeyReach API base URL https://api.heyreach.io/api/n8n.
  • Proper API authentication credentials must be configured in n8n for this node to function.

Troubleshooting

  • Common issues:
    • Pagination errors if offset or limit values are out of range (e.g., negative offset or limit > 1000).
    • Filtering by LinkedIn profile URL requires the URL to be in the exact specified format; otherwise, no results may be returned.
    • Missing or invalid API credentials will cause authentication failures.
  • Error messages:
    • Authentication errors typically indicate invalid or missing API keys.
    • Validation errors may occur if required parameters like offset or limit are missing or invalid.
    • API rate limits might cause temporary failures; retry after some time.

Links and References

Discussion