TeleFlow icon

TeleFlow

Interact with TeleFlow API
Join our community

Actions145

Overview

This node interacts with the TeleFlow API to perform various operations on different resources, including tenants. Specifically, the "Tenant - Get" operation retrieves detailed information about a tenant by its unique identifier. This is useful in scenarios where you need to fetch tenant details for reporting, auditing, or integration purposes.

For example, you might use this node to:

  • Retrieve tenant configuration or metadata before performing further processing.
  • Validate tenant existence and details during an automated workflow.
  • Fetch specific tenant fields dynamically based on workflow requirements.

Properties

Name Meaning
ID The unique identifier of the tenant resource to retrieve. This is required for the get operation.
Fields Optional field-value pairs to include as query parameters in the request, allowing more specific queries or filtering of returned data. Each pair consists of a field name and its corresponding value.

Output

The output is a JSON object representing the tenant resource retrieved from the TeleFlow API. It contains all the tenant's properties as returned by the API, which may include identifiers, names, configurations, and other metadata.

If additional fields were specified in the "Fields" property, the output reflects the filtered or specific data accordingly.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "tenant-id",
  "name": "Tenant Name",
  "otherProperty": "value",
  ...
}

Dependencies

  • Requires an active connection to the TeleFlow API via an API key credential configured in n8n.
  • The base URL for the API must be set in the node credentials.
  • The node uses HTTP methods GET, POST, PUT, DELETE depending on the operation, here specifically GET for the "get" operation.

Troubleshooting

  • Missing ID error: If the "ID" property is not provided for the get operation, the node will throw an error stating that the ID is required. Ensure the ID is correctly set.
  • API connectivity issues: Errors related to network or authentication failures can occur if the API key or base URL is misconfigured.
  • Invalid field names: Providing incorrect field names in the "Fields" property may result in unexpected API responses or errors.
  • To handle errors gracefully, enable the "Continue On Fail" option in the node settings to allow workflows to proceed even if this node encounters an error.

Links and References

Discussion