Mindz icon

Mindz

Interact with Mindz API

Actions116

Overview

The node interacts with the Mindz API to manage emails within specified email lists. Specifically, the Email - List operation retrieves a list of emails belonging to a given email list. This is useful for scenarios where you want to fetch and process batches of email addresses from your marketing or communication lists, such as exporting contacts, syncing with other systems, or filtering emails based on search criteria.

Practical examples:

  • Fetching all emails in a particular mailing list to send targeted campaigns.
  • Retrieving a paginated subset of emails for display or reporting.
  • Searching emails by keyword within a list to find specific contacts.

Properties

Name Meaning
Email List ID ID of the email list this email belongs to (required).
Limit Maximum number of email results to return (minimum 1, default 50).
Offset Number of email results to skip before starting to collect the output (default 0).
Sort By Field to sort the email results by. Options: Created At, ID, Email, Updated At.
Sort Direction Direction to sort results by. Options: Ascending, Descending.
Search Search term to filter email results by matching text.

Output

The node outputs a JSON array of email objects corresponding to the emails retrieved from the specified email list. Each object typically contains details about an individual email entry such as its ID, email address, creation date, update date, and possibly other metadata depending on the API response.

If binary data were involved (e.g., attachments), it would be summarized here, but this operation focuses on listing email records only.

Dependencies

  • Requires an active connection to the Mindz API via an OAuth2 API credential.
  • The node depends on the Mindz API service being available and accessible.
  • Proper permissions on the API key/credential to read email list data are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Email List ID will cause the API call to fail.
    • Exceeding API rate limits may result in errors or throttling.
    • Incorrect OAuth2 credentials or expired tokens will prevent successful API calls.
    • Providing invalid values for pagination (limit, offset) or sorting fields may cause errors.
  • Error messages and resolutions:

    • "Unauthorized" or "Invalid token": Check and refresh the OAuth2 credentials.
    • "Email List not found": Verify the Email List ID is correct and exists.
    • "Invalid parameter" related to limit or offset: Ensure these are positive integers within allowed ranges.
    • "API rate limit exceeded": Wait and retry after some time or optimize request frequency.

Links and References

Discussion