TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage various resources, including Tenants. Specifically, the "Tenant - Get Many" operation retrieves multiple tenant records from the TeleFlow system. It allows users to specify filtering fields to narrow down the list of tenants returned.

Common scenarios for this operation include:

  • Fetching a list of tenants for reporting or auditing purposes.
  • Retrieving tenants that match specific criteria (e.g., by name or other attributes).
  • Integrating tenant data into workflows for further processing or synchronization.

Example use case: A user wants to get all tenants whose "status" field equals "active" to process only currently active tenants in subsequent workflow steps.

Properties

Name Meaning
Fields Field-value pairs to filter the tenants returned by the request. Users can add multiple fields to refine the query. For example, specifying name = "TenantA" will return tenants matching that name.

The "Fields" property is a fixed collection allowing multiple entries, each with:

  • Name: The field name to filter on (string).
  • Value: The value to match for that field (string).

Output

The output is an array of JSON objects representing the tenants retrieved from the TeleFlow API. Each object corresponds to a tenant and contains its properties as returned by the API.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The base URL for the TeleFlow API must be configured in the node credentials.
  • The node uses HTTP requests to communicate with the TeleFlow REST endpoints.

Troubleshooting

  • Missing or invalid API credentials: Ensure the API key and base URL are correctly set in the node credentials.
  • Empty results: If no tenants are returned, verify that the filter fields are correct and that matching tenants exist.
  • ID required errors: This operation does not require an ID, but other operations like "get", "update", or "delete" do. Make sure to use the correct operation for your needs.
  • API request failures: Network issues or incorrect endpoint URLs can cause errors. Check connectivity and configuration.
  • Continue On Fail: If enabled, errors during execution will be captured in the output JSON under an error field instead of stopping the workflow.

Links and References

Discussion