Toolzz SubGroups icon

Toolzz SubGroups

ToolzzSubGroups

Overview

The Toolzz SubGroups node is designed to retrieve subgroup information from the Toolzz API based on specified group IDs and institution URL. It constructs a GET request to the Toolzz API endpoint, allowing users to filter subgroups by providing one or more group IDs. This node is useful in scenarios where you need to fetch subgroup data for reporting, automation, or integration with other systems within n8n workflows.

Practical examples:

  • Fetching all subgroups associated with specific groups in an educational institution.
  • Automating subgroup data retrieval for synchronization with external databases or CRMs.
  • Filtering and processing subgroup information as part of a larger workflow.

Properties

Name Type Meaning
Url of Institution String The base URL of the institution whose subgroups are being queried.
Ambiente Options Selects the environment (currently only "Prod" is available), which sets the API base URL.
Grupos String Comma-separated list of group IDs to filter the subgroups.

Output

The node outputs a JSON array containing the response from the Toolzz API. The structure of each item in the array depends on the API's /search/filters/subgroups endpoint, but typically includes details about each subgroup matching the provided group IDs.

Example output:

[
  {
    // Subgroup fields as returned by the Toolzz API
  }
]

Dependencies

  • External Service: Requires access to the Toolzz API at https://gateway.api.toolzz.com.br.
  • No authentication credentials are required by this node as per the current implementation.
  • n8n Configuration: No special configuration or environment variables are needed.

Troubleshooting

Common issues:

  • Invalid or missing "Url of Institution": If the URL is incorrect or empty, the API call may fail or return no results.
  • Incorrect "Grupos" format: Ensure group IDs are comma-separated without spaces.
  • Network/API errors: If the Toolzz API is unreachable or returns an error, the node will throw an error message.

Error messages and resolutions:

  • "Request failed with status code 4xx/5xx": Check the input parameters and ensure the Toolzz API is accessible.
  • "Cannot read property 'toString' of undefined": Make sure all required properties are filled in.

Links and References

Discussion