TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node interacts with the Twenty API to retrieve detailed information about a single "View" object by its unique identifier. It is useful when you need to fetch specific data about a particular view, including optionally nested related objects up to two levels deep. Typical use cases include displaying detailed view information in dashboards, integrating view data into other workflows, or performing conditional logic based on view properties.

Properties

Name Meaning
Id The unique identifier of the View object to retrieve. This is required.
Depth Determines how much related nested data to include in the response:
- 0: Only the primary View object.
- 1: The View plus its directly related objects.
- 2: The View, its related objects, and their related objects (two levels deep).

Output

The node outputs JSON data representing the requested View object. The structure includes the primary View's fields and, depending on the Depth parameter, may also include nested related objects. The exact shape depends on the API response but generally contains all relevant details of the View and its relationships as specified.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Twenty API.
  • The base URL for the API is configured via credentials.
  • The node uses the Twenty API version 1.0.3 OpenAPI specification internally.

Troubleshooting

  • Missing or invalid Id: If the Id property is empty or incorrect, the API will likely return an error indicating the object was not found. Ensure the Id is correct and corresponds to an existing View.
  • Authentication errors: If the API key credential is missing or invalid, authentication will fail. Verify that the API key is correctly set up in n8n credentials.
  • Depth parameter misuse: Providing an unsupported depth value might cause unexpected results or errors. Use only 0, 1, or 2 as allowed.
  • Network or API downtime: Connectivity issues or API service interruptions can cause request failures. Check network connectivity and API status.

Links and References

Discussion