TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node interacts with the Twenty API to retrieve detailed information about a single "View Field" object by its unique identifier. It is useful when you need to fetch specific metadata or configuration details of a view field within the Twenty platform, such as for display, processing, or integration purposes.

Common scenarios include:

  • Fetching configuration details of a particular view field to dynamically adjust UI elements.
  • Retrieving nested related objects up to a specified depth to understand relationships and dependencies.
  • Integrating Twenty view field data into other workflows or systems.

For example, you might use this node to get the details of a view field by its ID and include related objects one level deep to understand its immediate context.

Properties

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

Output

The node outputs JSON data representing the requested view field object. The structure includes the main object's properties and, depending on the Depth parameter, nested related objects up to the specified level.

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

Dependencies

  • Requires an API key credential for authenticating with the Twenty API.
  • The node uses the base URL configured via credentials to send requests.
  • No additional external dependencies are indicated beyond the Twenty API access.

Troubleshooting

  • Missing or invalid Id: The node requires a valid view field ID. Ensure the ID is correct and exists in the Twenty 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 and ensure no firewall or proxy blocks the request.

Links and References

Discussion