ImmyBot icon

ImmyBot

ImmyBot Node

Actions24

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 might use this node to:

  • Retrieve all tenants to display them 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 focuses on JSON tenant data only.

Dependencies

  • Requires an API key credential for authentication with the ImmyBot service.
  • The node expects a subdomain value in credentials to construct the base URL for API requests.
  • The API endpoint used is https://{subdomain}.immy.bot/api/v1.

Troubleshooting

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

Links and References

Discussion