Mindz icon

Mindz

Interact with Mindz API

Actions115

Overview

The node interacts with the Mindz API, specifically supporting multiple resources and operations. For the Bundle resource with the List operation, it retrieves a list of bundles from the Mindz platform. This is useful for workflows that need to fetch collections of bundled courses or products managed in Mindz.

Typical use cases include:

  • Displaying available bundles in an external dashboard.
  • Automating reporting or synchronization of bundle data.
  • Filtering and sorting bundles based on criteria like creation date or ID.

For example, you might use this node to get the first 50 bundles sorted by creation date ascending, optionally filtering by a search term.

Properties

Name Meaning
Limit Max number of results to return (minimum 1). Controls pagination size.
Offset Number of results to skip before starting to collect the output. Useful for paging.
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 by matching text.

Output

The node outputs JSON data representing the list of bundles retrieved from the Mindz API. The structure typically includes an array of bundle objects, each containing details such as bundle ID, creation date, name, and other relevant metadata.

If the API supports binary data for bundles (e.g., images or files), the node would handle those accordingly, but based on the provided code and properties, the output focuses on JSON data listing bundles.

Dependencies

  • Requires an active connection to the Mindz API via an OAuth2 API credential.
  • The node depends on the Mindz API being accessible and properly authenticated.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or expired API tokens.
    • API rate limits causing request throttling.
    • Incorrect property values (e.g., negative limit or offset) leading to errors.
    • Network connectivity problems preventing API access.
  • Error messages and resolutions:

    • "Authentication failed" — Verify the OAuth2 credentials and refresh tokens if necessary.
    • "Invalid parameter" — Check that limit is at least 1 and other parameters conform to expected types.
    • "API rate limit exceeded" — Implement retry logic or reduce request frequency.
    • "Network error" — Ensure stable internet connection and correct API endpoint configuration.

Links and References


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

Discussion