HeyReach API icon

HeyReach API

Interact with HeyReach API

Overview

The "Inbox - Get Many" operation in this node retrieves multiple conversation records from the HeyReach API inbox. It supports pagination and filtering, allowing users to fetch a subset of conversations based on criteria such as campaign association, LinkedIn lead identifiers, sender account IDs, search terms, and seen status.

This operation is useful for scenarios where you want to analyze or process batches of conversations, for example:

  • Exporting recent conversations for reporting.
  • Filtering conversations related to specific campaigns or leads.
  • Searching conversations by keywords or participant details.
  • Managing unread or unseen conversations.

Properties

Name Meaning
Offset Number of records to skip for pagination. Defaults to 0.
Limit Maximum number of records to return. Minimum 1, maximum 100. Defaults to 10.
Additional Fields Optional filters to narrow down the conversations returned:
- Campaign IDs Filter conversations by one or more associated campaign IDs (number array).
- Lead LinkedIn ID Filter conversations by the LinkedIn ID of the lead (string).
- Lead Profile URL Filter conversations by the full LinkedIn profile URL of the lead. Must be in format https://www.linkedin.com/in/username/.
- LinkedIn Account IDs Filter conversations by one or more LinkedIn sender account IDs (number array).
- Search String A search term to filter conversations, e.g., by message content or participant name (string).
- Seen Filter conversations based on whether they have been seen (boolean).

Output

The output contains a JSON array of conversation objects matching the specified filters and pagination parameters. Each conversation object typically includes details such as participants, messages, timestamps, campaign associations, and read/unread status.

If binary data were involved (e.g., attachments), it would be included separately, but this operation focuses on JSON conversation data only.

Dependencies

  • Requires an active connection to the HeyReach API via an API key credential configured in n8n.
  • The base URL for API requests is https://api.heyreach.io/api/n8n.
  • Proper permissions on the HeyReach account to access inbox conversations.

Troubleshooting

  • Empty results: Check that the offset and limit are set correctly and that any filters applied actually match existing conversations.
  • Invalid LinkedIn profile URL: Ensure the URL matches the required format exactly (https://www.linkedin.com/in/username/).
  • API authentication errors: Verify that the API key credential is valid and has not expired.
  • Limit exceeding 100: The API restricts the maximum number of records per request to 100; setting a higher limit will cause errors.
  • Network issues: Confirm network connectivity and that the HeyReach API endpoint is reachable.

Links and References

Discussion