Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions115

Overview

The node interacts with the Mindz API to manage and retrieve data related to email campaigns. Specifically, the Email Campaign - List operation fetches a list of email campaigns from the Mindz platform. This is useful for scenarios where you want to display, analyze, or process multiple email campaigns in bulk, such as generating reports, syncing campaign data with other systems, or filtering campaigns based on certain criteria.

Practical examples:

  • Retrieve the latest 50 email campaigns sorted by creation date to monitor recent marketing efforts.
  • Search for campaigns containing specific keywords in their titles or descriptions.
  • Paginate through campaigns using offset and limit parameters to handle large datasets efficiently.

Properties

Name Meaning
Limit Max number of results to return (minimum 1). Controls how many campaigns are fetched.
Offset Number of results to skip (minimum 0). Useful for pagination to skip a set of campaigns.
Search Search term to filter campaigns by matching text fields.
Sort By Field to sort results by. Options: ID, Sent, Created, Updated.
Sort Direction Direction to sort results by. Options: Ascending, Descending.

Output

The output contains a JSON array of email campaign objects retrieved from the Mindz API. Each object represents an individual email campaign with its associated properties such as ID, sent status, creation date, update date, and other relevant metadata.

If the node supports binary data output (not indicated here), it would typically represent attachments or exported campaign content, but this operation primarily returns structured JSON data about campaigns.

Dependencies

  • Requires an active connection to the Mindz API via an OAuth2-based API key credential configured in n8n.
  • The node depends on the Mindz API being accessible and the credentials having sufficient permissions to list email campaigns.

Troubleshooting

  • Common issues:

    • Invalid or expired API credentials will cause authentication failures.
    • Network connectivity problems can prevent access to the Mindz API.
    • Using an offset beyond the available number of campaigns may return empty results.
    • Providing invalid values for sorting or search parameters might result in errors or no data.

  • Error messages and resolutions:

    • Authentication failed: Check and refresh your API credentials.
    • Invalid parameter: Verify that "Limit" is at least 1, "Offset" is not negative, and "Sort By" and "Sort Direction" use valid options.
    • No results found: Adjust search terms or pagination parameters.

Links and References

Discussion