Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions116

Overview

The node interacts with the Mindz API to perform various operations on different resources. Specifically, for the Email List resource with the List operation, it retrieves a list of email lists from the Mindz platform. This is useful when you want to fetch and process multiple email lists, for example, to analyze mailing campaigns, segment contacts, or synchronize email lists with other systems.

Practical examples:

  • Fetching all email lists to display in a dashboard.
  • Retrieving email lists filtered by search terms to find specific groups.
  • Paginating through large numbers of email lists using limit and offset.
  • Sorting email lists by creation date or name to organize data presentation.

Properties

Name Meaning
Limit Max number of results to return (minimum 1).
Offset Number of results to skip before starting to collect the result set.
Sort By Field to sort results by. Options: Created At, ID, Name, Updated At.
Sort Direction Direction to sort results by. Options: Ascending, Descending.
Search Search term to filter results by matching text.

Output

The output contains a JSON array of email list objects retrieved from the Mindz API. Each object represents an email list with its associated properties such as ID, name, creation date, update date, and possibly other metadata depending on the API response.

If the node supports binary data output (not indicated here), it would typically represent attachments or exported files related to email lists, but this is not evident from the provided code and properties.

Dependencies

  • Requires an active connection to the Mindz API via an OAuth2-based API key credential.
  • The node depends on the Mindz API being accessible and properly authenticated.
  • No additional external services are explicitly required beyond the Mindz API.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or expired API credentials.
    • Network connectivity problems preventing access to the Mindz API.
    • Invalid parameter values, e.g., setting limit below 1.
    • Empty results if the search term does not match any email lists.

  • Error messages:

    • Authentication errors: Check that the API key credential is valid and has necessary permissions.
    • Validation errors: Ensure numeric inputs like limit and offset are within allowed ranges.
    • API errors: Review the Mindz API status and error details returned; adjust parameters accordingly.

Links and References

Discussion