HeyReach API icon

HeyReach API

Interact with HeyReach API
Join our community

Actions33

Overview

The "Get Many" operation for the Campaign resource in this HeyReach API node retrieves multiple campaign records with support for pagination and filtering. This operation is useful when you want to list campaigns in bulk, for example, to display them in a dashboard, analyze campaign performance, or synchronize campaign data with another system.

Typical use cases include:

  • Fetching a paginated list of campaigns to display in a UI.
  • Filtering campaigns by status or keyword to focus on specific subsets.
  • Retrieving campaigns associated with particular account IDs for segmented reporting.

Properties

Name Meaning
Offset Number of records to skip for pagination. Defaults to 0.
Limit Maximum number of records to return. Minimum is 1, maximum allowed is 100. Defaults to 10.
Additional Fields Collection of optional filters:
- Keyword A search keyword to filter campaigns by name or other relevant text fields. Leave empty to fetch all campaigns.
- Statuses Array of campaign statuses to filter results. Possible values: Draft, In Progress, Paused, Finished, Canceled, Failed, Starting.
- Account IDs Array of account IDs (integers) to filter campaigns belonging to specific accounts. Enter as JSON array, e.g., [1, 2, 3].

Output

The node outputs an array of campaign objects in the json field of each item. Each object represents a campaign record retrieved from HeyReach API and includes details such as campaign name, status, associated account ID, and other metadata as provided by the API.

If binary data were supported, it would typically represent attachments or media related to campaigns, but this operation focuses on JSON data only.

Dependencies

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

Troubleshooting

  • Common issues:

    • Pagination parameters (offset and limit) out of range may cause errors or unexpected results.
    • Providing invalid status values in the filter will likely result in no matches or API errors.
    • Incorrectly formatted accountIds (not a JSON array of integers) can cause request failures.

  • Error messages:

    • Authentication errors indicate missing or invalid API credentials; verify your API key setup.
    • Validation errors on input parameters suggest checking the types and allowed values, especially for filters.
    • Network or timeout errors require checking connectivity to the HeyReach API endpoint.

Links and References

  • HeyReach API Documentation (general): https://docs.heyreach.io/
  • HeyReach Campaigns API Reference (if available): Refer to official HeyReach API docs for detailed campaign endpoints and parameters.

Discussion