HeyReach API icon

HeyReach API

Interact with HeyReach API
Join our community

Actions33

Overview

The "Get Leads" operation under the "Campaign" resource in this HeyReach API node retrieves lead records associated with a specific campaign. It supports pagination and filtering by creation time or other time-based criteria. This operation is useful for marketing automation, sales prospecting, or CRM integration scenarios where you want to fetch leads generated from particular campaigns for further processing, analysis, or follow-up.

Practical examples include:

  • Extracting new leads created within a certain date range from a campaign to sync with a CRM.
  • Paginating through large sets of leads to process them in batches.
  • Filtering leads based on their creation time to focus on recent activity.

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.
Campaign ID The numeric ID of the campaign from which to retrieve leads.
Additional Fields Collection of optional filters:
• Time From: Filter leads created on or after this timestamp.
• Time To: Filter leads created before or at this timestamp.
• Time Filter: Type of time filter to apply; options are "Creation Time" or "Everywhere". Defaults to "Everywhere".

Output

The output JSON contains an array of lead objects retrieved from the specified campaign. Each lead object includes details such as lead identifiers, contact information, timestamps, and any other metadata provided by the HeyReach API related to that lead.

If binary data is returned (not indicated here), it would typically represent attachments or files associated with leads, but this operation primarily returns structured JSON lead data.

Dependencies

  • Requires an API key credential for authenticating with the HeyReach API.
  • The node uses the base URL https://api.heyreach.io/api/n8n for API requests.
  • Proper configuration of the HeyReach API credentials in n8n is necessary.

Troubleshooting

  • Invalid Campaign ID: If the campaign ID does not exist or is incorrect, the API may return an error or empty results. Verify the campaign ID is correct.
  • Pagination Limits: Setting limit above 100 may cause errors or be ignored. Keep the limit between 1 and 100.
  • Date Filters: Incorrectly formatted dates in "Time From" or "Time To" fields can cause request failures. Use valid ISO 8601 datetime formats.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Empty Results: If no leads are returned, check if the campaign actually has leads matching the filters and that the offset is within range.

Links and References

Discussion