Actions116
- Course Actions
- Bundle Actions
- Course Grade Actions
- Course Grade Detail Actions
- Course Teacher Actions
- Email Actions
- Email Campaign Actions
- Email Campaign Course Actions
- Email Campaign Excluded Course Actions
- Email Campaign Excluded List Actions
- Email Campaign Excluded Plan Actions
- Email Campaign List Actions
- Email Campaign Plan Actions
- Email List Actions
- Enroll Actions
- MindzPay Account Actions
- MindzPay Invoice Actions
- MindzPay Payment Actions
- MindzPay Subscription Actions
- Subscription Actions
- Team Actions
- User Actions
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 where you need to display or process batches of enrollment data, such as generating reports, syncing enrollment information with other systems, or monitoring user participation.
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
| Name | Meaning |
|---|---|
| Limit | Max number of results to return (minimum 1). Controls page size of returned enrollments. |
| Offset | Number of results to skip before starting to collect the result set. Useful for paging. |
| Sort By | Field to sort results by. Options: Created At, Expiry Date, ID, Updated At. |
| Sort Direction | Direction to sort results by. Options: Ascending, Descending. |
| Search | Search term to filter results by matching text. |
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 identifiers and metadata about each enrollment.
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 service being available and accessible.
- Proper configuration of the Mindz OAuth2 credentials within n8n is necessary.
Troubleshooting
Common issues:
- Authentication failures due to invalid or expired API tokens.
- Network connectivity problems preventing access to the Mindz API.
- Invalid parameter values (e.g., negative limit or offset) causing API errors.
- Exceeding API rate limits resulting in throttling or temporary blocks.
Error messages and resolutions:
- Unauthorized / 401 errors: Check and refresh the API authentication token.
- Bad Request / 400 errors: Verify that input parameters like limit, offset, and sort options are valid.
- Timeouts or network errors: Ensure stable internet connection and Mindz API endpoint availability.
- Empty results: Confirm that the search term and filters match existing enrollments.
Links and References
- Mindz API Documentation (general reference for endpoints and parameters)
- n8n OAuth2 Credential Setup Guide
- Pagination and Sorting Best Practices in APIs