Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions115

Overview

The node interacts with the Mindz API to manage subscriptions. Specifically, the Subscription - List operation retrieves a list of subscription records from the Mindz platform. This is useful for scenarios where you want to fetch multiple subscription entries, such as displaying active subscriptions, generating reports, or syncing subscription data with other systems.

Practical examples include:

  • Fetching all subscriptions created within a certain timeframe.
  • Retrieving a paginated list of subscriptions to display in a dashboard.
  • Searching subscriptions by specific criteria to filter results.

Properties

Name Meaning
Limit Max number of subscription results to return (minimum 1).
Offset Number of subscription results to skip (for pagination).
Sort By Field to sort subscription results by. Options: Created At, ID.
Sort Direction Direction to sort subscription results. Options: Ascending, Descending.
Search Search term to filter subscription results by matching relevant fields.

Output

The output contains a JSON array of subscription objects retrieved from the Mindz API. Each object represents a subscription record with its associated data fields (such as ID, creation date, user info, status, etc.). The exact structure depends on the Mindz API response schema for subscriptions.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Mindz API.
  • The node depends on the Mindz API being accessible and properly configured.
  • No additional external services are required beyond the Mindz API.

Troubleshooting

  • Common issues:

    • Invalid or expired API credentials will cause authentication failures.
    • Providing invalid values for pagination (e.g., negative limit or offset) may result in errors.
    • Network connectivity problems can prevent successful API calls.
    • Using unsupported sort fields or directions might cause the API to reject the request.

  • Error messages and resolutions:

    • Authentication failed: Verify that the API key credential is correct and has not expired.
    • Invalid parameter: Check that limit and offset are numbers within allowed ranges; ensure sortBy and sortDirection use valid options.
    • Network error: Confirm internet connectivity and that the Mindz API endpoint is reachable.
    • Empty results: If no subscriptions match the search term or filters, try broadening the search criteria.

Links and References

Discussion