Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions116

Overview

The node interacts with the Mindz API to manage and retrieve information about teams within the Mindz platform. Specifically, the "Team" resource with the "List" operation allows users to fetch a list of teams with options to control pagination, sorting, and filtering by search terms.

This node is beneficial in scenarios where you need to:

  • Retrieve a paginated list of teams for display or further processing.
  • Search for specific teams by name or other attributes.
  • Sort teams by various fields such as date joined, email, or names.

Practical examples include:

  • Building dashboards that show team lists filtered by user input.
  • Automating reports on team memberships sorted by join date.
  • Integrating team data into other systems by fetching batches of teams with controlled limits and offsets.

Properties

Name Meaning
Limit Max number of results to return (minimum 1). Controls how many teams are fetched per call.
Offset Number of results to skip. Useful for pagination to skip a certain number of teams.
Sort By Field to sort results by. Options: Date Joined, Email, First Name, ID, Last Name.
Sort Direction Direction to sort results by. Options: Ascending, Descending.
Search Search term to filter results. Filters teams based on this string.

Output

The output contains a JSON array of team objects matching the query parameters. Each object represents a team with its associated properties as returned by the Mindz API.

If the node supports binary data output (not indicated here), it would typically represent files or media related to teams, but this operation focuses on JSON data only.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or expired API credentials will cause authentication failures.
    • Exceeding API rate limits may result in errors or throttled responses.
    • Providing invalid values for pagination or sorting parameters might lead to unexpected results or errors.

  • Error messages:

    • Authentication errors: Check that the API key credential is valid and has not expired.
    • Validation errors: Ensure "Limit" is at least 1 and other parameters conform to expected types.
    • Network errors: Verify network connectivity and Mindz API availability.

Resolving these usually involves verifying credentials, adjusting parameter values, and ensuring stable network conditions.

Links and References

Discussion