Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions115

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, segmenting users, or syncing email data with other systems.

Practical examples:

  • Fetching all emails in a particular mailing list to send targeted campaigns.
  • Retrieving emails with pagination and sorting to display in a dashboard.
  • Searching for specific emails within a list to verify subscription status.

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 (default 0), useful for pagination.
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 output contains a JSON array of email objects retrieved from the specified email list. Each object typically includes details such as the email address, its unique ID, creation and update timestamps, and possibly other metadata related to the email entry.

If the node supports binary data output (not explicitly shown here), it would represent attachments or files related to emails, but for this operation, the focus is on JSON data representing email records.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing Email List ID will cause the request 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 limit, offset, or unsupported sortBy fields can cause errors.

  • Error messages and resolutions:

    • "Unauthorized" or "Invalid credentials": Check that the API key credential is correctly configured and has not expired.
    • "Email list not found": Verify the Email List ID is correct and exists in the Mindz system.
    • "Invalid parameter" errors: Ensure numeric fields like limit and offset are within allowed ranges and options for sorting are valid.
    • Timeouts or network errors: Confirm network connectivity and Mindz API availability.

Links and References

Discussion