Overkiz (Tahoma) icon

Overkiz (Tahoma)

Interact with Overkiz (Tahoma) API

Actions3

Overview

The Overkiz (Tahoma) - Object: Get By Type node allows you to retrieve all Overkiz objects (devices) of a specific type from your Overkiz (Tahoma) account. This is useful for filtering and working with only certain categories of devices, such as lights, shutters, or sensors, based on their type.

Common scenarios:

  • Automating workflows that need to interact with all devices of a particular type (e.g., turning off all lights).
  • Generating reports or dashboards filtered by device type.
  • Triggering actions or notifications when new devices of a certain type are detected.

Practical example:
You want to get a list of all "Light" devices in your smart home system to display their status or control them collectively.

Properties

Name Meaning
Object Type Name or ID List of available object types to filter. Multiples can be defined separated by comma. Choose from the list, or specify an ID using an expression.

Output

The output is an array of objects, each representing an Overkiz object (device) matching the selected type. Each item is returned in the json field.

Example output structure:

[
  {
    "json": {
      "name": "Living Room Light",
      "URL": "io://1234-5678-90/1",
      "widget": "Light",
      "definition": {
        "uiClass": "Light"
        // ...other device properties
      }
      // ...additional fields depending on the device
    }
  },
  ...
]
  • Each json object contains details about a single device, including its name, URL, widget type, and definition.

Dependencies

  • External Service: Requires access to the Overkiz (Tahoma) API.
  • Credentials: You must configure valid overkizApi credentials in n8n for this node to function.

Troubleshooting

Common issues:

  • Missing Credentials:
    Error message: No credentials!
    Resolution: Ensure you have set up and selected the correct Overkiz API credentials in the node.

  • No Devices Returned:
    If no devices are returned, verify that the selected "Object Type Name or ID" matches existing device types in your Overkiz account.

  • Invalid Object Type:
    If you manually enter an object type that does not exist, the result will be an empty array.

Links and References

Discussion