TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to perform various operations on different resources, including devices. Specifically, for the Device - Get operation, it retrieves detailed information about a single device by its unique identifier. This is useful in scenarios where you need to fetch current device details for monitoring, auditing, or further processing within an automation workflow.

For example, you might use this node to:

  • Retrieve configuration or status of a specific device before updating it.
  • Fetch device details to include in reports or notifications.
  • Validate device existence and properties as part of a larger provisioning process.

Properties

Name Meaning
ID The unique identifier of the device resource to retrieve. This is required.
Fields Optional key-value pairs specifying additional fields to include in the request query string. You can add multiple fields by name and value to filter or customize the returned data.

Output

The output is a JSON object representing the device resource retrieved from the TeleFlow API. It contains all the standard device properties as defined by the API, potentially filtered or extended by the optional fields specified.

Example structure (simplified):

{
  "id": "string",
  "name": "string",
  "type": "string",
  "otherProperties": "..."
}

No binary data output is produced by this operation.

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 credentials.
  • The node uses HTTP GET requests to fetch device data.

Troubleshooting

  • Missing ID error: If the ID property is not provided, the node will throw an error stating that the ID is required for the get operation. Ensure the ID field is filled correctly.
  • API connectivity issues: Network errors or invalid credentials will cause HTTP request failures. Verify API keys and network access.
  • Invalid field names: Providing incorrect field names in the Fields collection may result in incomplete or empty responses. Double-check field names against the TeleFlow API documentation.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Discussion