Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions116

Overview

The node interacts with the Mindz API to list subscription records. It allows users to retrieve a paginated, sorted, and filtered list of subscriptions from their Mindz account. This is useful for scenarios such as managing user subscriptions, auditing subscription data, or integrating subscription information into workflows.

Practical examples:

  • Fetching the first 50 subscriptions sorted by creation date ascending.
  • Retrieving subscriptions starting from an offset to implement pagination in a dashboard.
  • Searching subscriptions by a keyword to filter relevant entries.

Properties

Name Meaning
Limit Max number of subscription results to return (minimum 1). Default is 50.
Offset Number of subscription results to skip before starting to collect the output. Default 0.
Sort By Field to sort the subscription results by. Options: "Created At", "ID". Default is "ID".
Sort Direction Direction to sort the results. Options: "Ascending", "Descending". Default is "Ascending".
Search Search term to filter subscription results by matching text. Default is empty (no filter).

Output

The node outputs JSON data representing a list of subscription objects retrieved from the Mindz API. Each item in the output array corresponds to a subscription record containing its details as provided by the API.

If the API supports binary data related to subscriptions (e.g., documents or attachments), the node would handle it accordingly, but based on the provided code and properties, the output focuses on JSON subscription data 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 API credentials must be configured in n8n to authenticate requests.

Troubleshooting

  • Common issues:

    • Invalid or expired API credentials will cause authentication failures.
    • Providing an invalid value for "Limit" (less than 1) may result in errors or default behavior.
    • Network connectivity problems can prevent successful API calls.
    • Using unsupported search terms or sorting fields might yield no results or errors.

  • Error messages:

    • Authentication errors typically indicate issues with the API key or OAuth token; re-authenticate or update credentials.
    • Validation errors on parameters like limit or offset suggest correcting input values.
    • API rate limiting errors require waiting or adjusting request frequency.

Links and References

Discussion