Mindz icon

Mindz

Interact with Mindz API

Actions115

Overview

The node interacts with the Mindz API to perform various operations on different resources. Specifically, for the User resource with the List operation, it retrieves a list of users from the Mindz platform. This is useful when you want to fetch user data in bulk, such as for reporting, synchronization with other systems, or batch processing.

Practical examples include:

  • Fetching a paginated list of users to display in an admin dashboard.
  • Retrieving users filtered by search terms for targeted marketing campaigns.
  • Exporting user data for analysis or backup.

Properties

Name Meaning
Limit Max number of user results to return (minimum 1).
Offset Number of user results to skip before starting to collect the output (for pagination).
Sort By Field to sort the user results by. Options: Date Joined, ID.
Sort Direction Direction to sort the results. Options: Ascending, Descending.
Search Search term to filter user results by matching relevant fields.

Output

The node outputs JSON data containing the list of users retrieved from the Mindz API. Each item in the output array represents a user object with properties as defined by the Mindz API user schema (e.g., id, date joined, name, email, etc.).

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Mindz API via an OAuth2-based API key credential.
  • The node depends on proper configuration of this API authentication within n8n.
  • Network access to the Mindz API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or expired API credentials.
    • Pagination parameters (limit and offset) set incorrectly causing empty or incomplete results.
    • Using unsupported values for sorting fields or directions may cause errors.
    • Network connectivity problems preventing API calls.
  • Error messages and resolutions:

    • "Unauthorized" or "Authentication failed": Verify that the API key credential is valid and has not expired.
    • "Invalid parameter" related to limit, offset, sortBy, or sortDirection: Check that these inputs conform to allowed values and types.
    • "Timeout" or "Network error": Ensure stable internet connection and that Mindz API endpoints are reachable.

Links and References


If you need details about other resources or operations, feel free to ask!

Discussion