TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node integrates with the TeleFlow API to perform various operations on different resources, including users. Specifically, for the User resource and the Get Many operation, it retrieves multiple user records from the TeleFlow system. This is useful when you want to fetch a list of users, optionally filtered by specific fields.

Common scenarios include:

  • Synchronizing user data from TeleFlow into another system.
  • Generating reports or dashboards based on user information.
  • Automating workflows that require bulk user data retrieval.

For example, you might use this node to get all users who belong to a certain department or have a specific role by specifying those as filter fields.

Properties

Name Meaning
Fields A collection of field-value pairs used to filter the users returned by the request. You can specify multiple fields to narrow down the query results. For each field, provide the field name and the value to match.

The "Fields" property allows adding multiple filters, such as:

  • Name: The name of the field to filter by (e.g., "username", "email").
  • Value: The value to match for that field.

Output

The output is an array of JSON objects representing the users retrieved from the TeleFlow API. Each object contains the user data fields as returned by the API, which may include usernames, emails, IDs, and other user-related attributes.

No binary data is output by this node.

Example output structure (simplified):

[
  {
    "id": "123",
    "username": "jdoe",
    "email": "jdoe@example.com",
    ...
  },
  {
    "id": "124",
    "username": "asmith",
    "email": "asmith@example.com",
    ...
  }
]

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 API.

Troubleshooting

  • Missing or invalid API credentials: Ensure the API key and base URL are correctly set in the node credentials.
  • Invalid field names or values: If filtering fields do not match the API's expected parameters, the request may return no results or errors.
  • Network issues: Connectivity problems can cause request failures; verify network access to the TeleFlow API endpoint.
  • Error messages about missing ID: These apply to other operations like "get" or "update" but not "getAll". For "getMany" (getAll), no ID is required.

If the node throws an error, check the error message logged. If "continue on fail" is enabled, errors will be included in the output JSON under an error property.

Links and References

Discussion