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 Group" by its unique identifier. It is useful when you need to fetch a single filter group object, optionally including related nested objects up to a specified depth level. Typical use cases include dynamically loading filter configurations for dashboards or reports where understanding the structure and relationships of filter groups is necessary.

Properties

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

Output

The node outputs a JSON object representing the requested View Filter Group. Depending on the Depth parameter, this JSON may include nested related objects:

  • At depth 0, only the main View Filter Group's properties are returned.
  • At depth 1, the output includes the main object plus its immediate related entities.
  • At depth 2, the output further includes related objects of those immediate related entities.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating requests to the Twenty API.
  • The base URL for the API is configured via credentials.
  • The node uses standard HTTP headers for JSON content negotiation.

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 object id is provided.
  • Authentication errors: If the API key credential is missing or invalid, authentication failures will occur. Verify that the API key is correctly set up in n8n credentials.
  • Invalid depth value: Although the UI restricts depth to 0, 1, or 2, passing an unsupported value might cause unexpected results or API errors.
  • Network issues: Connectivity problems to the API endpoint can cause request failures. Check network access and API availability.

Links and References

Discussion