Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions115

Overview

The node interacts with the Mindz API to perform various operations on different resources. Specifically, for the Course resource and the List operation, it retrieves a list of courses from the Mindz platform. This is useful when you want to fetch multiple course records, possibly filtered or sorted, for further processing or integration in your workflow.

Common scenarios include:

  • Displaying available courses in an external dashboard.
  • Synchronizing course data with another system.
  • Automating reporting or analytics based on course information.

For example, you might use this node to get the first 50 courses sorted by creation date ascending, or to search for courses matching a specific keyword.

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.
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 text.

Output

The output contains a JSON array of course objects retrieved from the Mindz API. Each object represents a course with its associated properties as defined by the API schema (e.g., course ID, name, creation date, etc.).

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

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

  • Authentication errors: Ensure that the OAuth2 API credential is correctly configured and has not expired.
  • Empty results: Check if the search parameter is too restrictive or if the offset exceeds the total number of courses.
  • Invalid parameter values: For example, setting limit below 1 may cause errors; ensure parameters respect their constraints.
  • API rate limits: If many requests are made in a short time, the API might throttle responses; consider adding delays or reducing request frequency.

Links and References

Discussion