Mindz icon

Mindz

Interact with Mindz API

Actions116

Overview

The node provides integration with the Mindz API, allowing users to interact with various Mindz resources such as bundles, courses, users, teams, subscriptions, emails, and payment-related entities. Specifically, for the Bundle - List operation, the node fetches a list of bundle records from the Mindz platform.

This operation is useful when you want to retrieve multiple bundles with control over pagination, sorting, and filtering by search terms. For example, you might use it to display available bundles in a dashboard, synchronize bundles with another system, or analyze bundle data.

Properties

Name Meaning
Limit Max number of results to return (minimum 1). Controls page size of returned bundles.
Offset Number of results to skip. Useful for pagination to fetch subsequent pages of bundles.
Sort By Field to sort results by. Options: Created At, ID.
Sort Direction Direction to sort results by. Options: Ascending, Descending.
Search Search term to filter results. Filters bundles matching the given string.

Output

The output contains a JSON array of bundle objects retrieved from the Mindz API according to the specified parameters. Each object represents a bundle with its associated properties as defined by the Mindz API schema.

If the node supports binary data output for this operation (not indicated explicitly here), it would typically represent files or media related to bundles, but for listing bundles, the output is primarily structured JSON data.

Dependencies

  • Requires an active connection to the Mindz API using an OAuth2-based API key credential.
  • The node depends on the Mindz API being accessible and properly authenticated.
  • No additional external services are 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 such as negative limits or offsets.
    • API rate limiting if too many requests are made in a short time.
  • Error messages:

    • Unauthorized / 401 errors: Check that the API key credential is valid and has not expired.
    • Bad Request / 400 errors: Verify that input parameters like limit, offset, and sort options are correctly set.
    • Timeouts or network errors: Ensure stable internet connection and that the Mindz API endpoint is reachable.

Resolving these usually involves verifying credentials, adjusting parameters, and ensuring network stability.

Links and References


Note: This summary is based solely on static analysis of the provided source code and property definitions.

Discussion