MindzInstall

Overview

The "Enroll - List" operation in this node interacts with the Mindz API to retrieve a list of enrollment records. It allows users to fetch multiple enrollments with control over pagination, sorting, and filtering by search terms. This is useful for scenarios such as generating reports on user enrollments, auditing active or expired enrollments, or integrating enrollment data into other workflows.

Practical examples:

• Fetching the first 50 enrollments sorted by creation date ascending.
• Retrieving enrollments starting from an offset to paginate through large datasets.
• Searching enrollments by a keyword to filter relevant records.

Properties

Output

The output contains a JSON array of enrollment objects retrieved from the Mindz API according to the specified parameters. Each object represents an enrollment record with its associated fields (such as IDs, dates, status, etc.). The exact structure depends on the API response but typically includes enrollment metadata.

No binary data output is indicated for this operation.

Dependencies

• Requires an API key credential for authenticating with the Mindz API.
• The node uses OAuth2 authentication configured in n8n credentials.
• Network access to the Mindz API endpoint is necessary.

Troubleshooting

• Common issues:
  • Invalid or missing API credentials will cause authentication failures.
  • Exceeding API rate limits may result in errors or throttled responses.
  • Providing invalid parameter values (e.g., negative limit) may cause request rejections.
• Error messages:
  • Authentication errors: Check that the API key or OAuth2 token is correctly configured and valid.
  • Validation errors: Ensure numeric inputs like Limit and Offset are within allowed ranges.
  • Network errors: Verify connectivity to the Mindz API service.

Links and References

• Mindz API documentation (refer to official API docs for detailed schema and endpoints)
• n8n OAuth2 credential setup guide (for configuring API authentication)