TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node interacts with the Twenty API to retrieve detailed information about a specific "View Filter" object by its unique identifier. It is useful when you need to fetch a single view filter's data, including optionally nested related objects, for further processing or decision-making in your workflow.

Common scenarios include:

  • Fetching configuration details of a particular view filter to customize UI or reports.
  • Retrieving metadata for validation or audit purposes.
  • Integrating with other systems that require detailed filter information.

For example, you might use this node to get a view filter by its ID and then use the retrieved data to dynamically adjust subsequent workflow steps based on the filter’s properties.

Properties

Name Meaning
Id The unique identifier of the view filter object to retrieve. This is required.
Depth Determines how much related nested data to include in the response:
- 0: Only the primary view filter object.
- 1: Primary object plus directly related objects.
- 2: Primary object, directly related objects, and their related objects.

Output

The node outputs JSON data representing the requested view filter object. The structure includes the main view filter fields and, depending on the Depth property, may also include nested related objects up to two levels deep.

If binary data were involved (not indicated here), it would typically represent files or media associated with the view filter, but this node focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating requests to the Twenty API.
  • The node expects the base URL for the API to be configured via credentials.
  • No additional external dependencies are needed beyond the Twenty API access.

Troubleshooting

  • Missing or invalid Id: The node requires a valid view filter ID. Ensure the ID is correct and exists in the system.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Depth parameter misuse: Using a depth value outside the allowed range (0, 1, 2) may cause unexpected results or errors.
  • Network issues: Check connectivity to the Twenty API endpoint if requests time out or fail.

Links and References

Discussion