Mindz icon

Mindz

Interact with Mindz API

Actions116

Overview

The node interacts with the Mindz API to list courses available in the system. It allows users to retrieve a paginated and sorted list of courses, optionally filtered by a search term. This is useful for scenarios where you want to display or process multiple courses, such as generating reports, syncing course data with other systems, or building dashboards that show available courses.

Practical examples:

  • Fetching the first 50 courses sorted by creation date ascending.
  • Searching for courses containing a specific keyword in their title or description.
  • Skipping the first 100 courses and retrieving the next 50 for pagination purposes.

Properties

Name Meaning
Limit Max number of results to return (minimum 1).
Offset Number of results to skip before starting to collect the result set (for pagination).
Sort By Field to sort results by: "Created At" or "ID".
Sort Direction Direction to sort results by: "Ascending" or "Descending".
Search Search term to filter results by matching relevant course fields.

Output

The output contains a JSON array of course objects representing the retrieved courses. Each object includes details about a course as provided by the Mindz API. The exact structure depends on the API response but typically includes identifiers, titles, creation dates, and other metadata related to each course.

No binary data output is indicated for this operation.

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 environment variables are explicitly required beyond the configured API credentials.

Troubleshooting

  • Common issues:
    • Authentication failures due to invalid or expired API tokens.
    • Network connectivity problems preventing access to the Mindz API.
    • Invalid parameter values such as negative limits or offsets.
  • Error messages:
    • Errors indicating unauthorized access usually mean the API credentials need to be reconfigured or refreshed.
    • Validation errors on parameters suggest checking the input values for correctness (e.g., limit must be ≥ 1).
    • Timeout or network errors require verifying internet connectivity and API endpoint availability.

Links and References

Discussion