TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node interacts with the Twenty API to retrieve detailed information about a specific "View Group" by its unique identifier. It is useful when you need to fetch a single view group’s data, optionally including related nested objects up to two levels deep. Typical use cases include integrating view group details into workflows for reporting, auditing, or further processing within n8n.

For example, you might use this node to:

  • Retrieve a view group’s core data by its ID.
  • Include directly related objects (like associated users or permissions) to get a richer dataset.
  • Fetch nested related objects for complex hierarchical data inspection.

Properties

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

Output

The node outputs JSON data representing the requested view group object. Depending on the Depth property, this JSON may include nested related objects:

  • At depth 0, only the main view group’s fields are returned.
  • At depth 1, the output includes the view group plus its immediate related objects.
  • At depth 2, the output contains the view group, its related objects, and the related objects of those related objects.

No binary data output is produced by this node.

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 beyond the Twenty API and its authentication.

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 correct view group ID is provided.
  • Authentication errors: If the API key or domain credentials are missing or invalid, the node will fail to authenticate. Verify that the API key credential is correctly set up.
  • Invalid Depth value: Although the UI restricts values to 0, 1, or 2, if an unsupported value is somehow sent, the API may reject the request or ignore the parameter.
  • Network issues: Connectivity problems to the Twenty API endpoint can cause timeouts or failures. Check network access and API availability.

Links and References

Discussion