Toolzz Groups icon

Toolzz Groups

ToolzzGroups

Overview

The Toolzz Groups node is designed to retrieve group information from a Toolzz-based institution. It performs an HTTP GET request to the Toolzz API, targeting the /search/filters/groups endpoint of the specified environment (Ambiente) and institution URL. This node is useful for scenarios where you need to fetch or synchronize group data from a Toolzz platform into your n8n workflows, such as automating user management, reporting, or integration with other systems.

Practical Example:
You might use this node to periodically pull the latest groups from your Toolzz institution and update a CRM, send notifications, or trigger further automation based on group membership.

Properties

Name Type Meaning
Url of Institution String The base URL of the Toolzz institution whose groups you want to retrieve.
Ambiente Options Selects the environment for the API call. Currently, only "Prod" (https://gateway.api.toolzz.com.br) is available.

Output

  • The node outputs a JSON array containing the response from the Toolzz API's /search/filters/groups endpoint.
  • The structure of each item in the output array depends on the API's response, but typically includes details about each group (such as group ID, name, etc.).

Example Output:

[
  {
    "id": "group1",
    "name": "Group One",
    // ...other group fields
  },
  {
    "id": "group2",
    "name": "Group Two"
    // ...other group fields
  }
]

Dependencies

  • Requires network access to https://gateway.api.toolzz.com.br.
  • No authentication credentials are required by this node as per the provided code.
  • No special n8n 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.
    • Network errors: If n8n cannot reach the Toolzz API endpoint, you'll receive connection or timeout errors.
    • Unexpected API changes: If the Toolzz API changes its response format, the output may not match expectations.

  • Error Messages:

    • "Request failed with status code XXX": Indicates an issue with the API endpoint, such as a 404 (not found) or 500 (server error). Check the "Url of Institution" and try again.
    • "Cannot read property '...' of undefined": May occur if the API response is not as expected. Double-check the input parameters.

Links and References

Discussion