ImmyBotInstall

Overview

The node interacts with the ImmyBot API to retrieve multiple tenant records. Specifically, the "Get Many Tenants" operation fetches a list of tenants, optionally filtered by their name. This is useful in scenarios where you need to manage or analyze multiple tenants within an organization or system, such as generating reports, syncing tenant data, or performing bulk operations.

For example, you could use this node to:

• Retrieve all tenants to display in a dashboard.
• Filter tenants by a specific company name pattern to target communications or updates.
• Automate tenant data synchronization between ImmyBot and another system.

Properties

Name	Meaning
Name Filter (Optional)	A string filter to narrow down tenants by their name. Example format: (name==Example Company Inc.). Leave empty to retrieve all tenants without filtering.

Output

The node outputs JSON data representing the list of tenants retrieved from the ImmyBot API. Each item in the output corresponds to a tenant object containing its details as provided by the API.

If binary data were involved, it would be summarized here, but this node deals only with JSON tenant data.

Dependencies

• Requires an API key credential for authentication with the ImmyBot service.
• The node uses the subdomain specified in the credentials to construct the base URL for API requests.
• The API expects JSON content type and returns JSON responses.

Troubleshooting

• Empty results: If no tenants are returned, verify that the filter syntax is correct or try removing the filter to get all tenants.
• Authentication errors: Ensure the API key credential is valid and has the necessary permissions.
• Network issues: Confirm that the subdomain in the credentials is correct and that the ImmyBot API is reachable.
• Invalid filter format: The filter must follow the expected syntax (name==...); incorrect formatting may cause errors or no results.

Links and References

• ImmyBot API documentation (refer to official docs for detailed filter syntax and tenant data structure)
• n8n documentation on creating and using API credentials