TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation allows you to create a new View Filter Group within a specified view. A View Filter Group is a logical grouping of filters that can be combined using logical operators (AND, OR, NOT) to refine data views. This operation is useful when you want to programmatically build complex filter criteria for data views, enabling dynamic and flexible data querying.

Practical examples include:

  • Creating nested filter groups to segment data based on multiple conditions.
  • Automating the setup of filters in dashboards or reports.
  • Structuring filters hierarchically by specifying parent filter groups and their positions.

Properties

Name Meaning
Depth Determines how much related object data to include in the response:
- 0: Only primary object's information.
- 1: Primary object plus directly related objects.
- 2: Primary object, its related objects, and their related objects.
View Id The identifier of the view where the filter group will be created.
Parent View Filter Group Id The identifier of the parent filter group under which this new filter group will be nested. If omitted, the filter group is created at the root level.
Logical Operator The logical operator to apply within this filter group. Options are: AND, OR, NOT. This defines how filters inside the group are combined logically.
Position In View Filter Group The position index of this filter group within its parent filter group, determining order among sibling filter groups.

Output

The output JSON contains the details of the newly created View Filter Group, including its identifiers, logical operator, position, and any nested relationships depending on the Depth parameter. This allows subsequent nodes or workflows to reference or manipulate the created filter group.

If binary data were involved (not indicated here), it would typically represent attachments or files related to the filter group, but this node focuses on JSON data only.

Dependencies

  • Requires an API key credential to authenticate with the external Twenty API service.
  • The node uses the base URL configured in the credentials to send requests.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing an invalid viewId or parentViewFilterGroupId may result in errors indicating resource not found.
    • Incorrect logical operator values outside the allowed options will cause validation errors.
    • Position values that conflict with existing filter groups might lead to unexpected ordering or errors.

  • Error messages and resolutions:

    • Authentication failed: Verify that the API key credential is correctly configured and has necessary permissions.
    • Resource not found: Check that the provided viewId and parentViewFilterGroupId exist and are accessible.
    • Invalid parameter: Ensure all input properties conform to expected types and allowed values.
    • Request failed: Inspect network connectivity and API endpoint availability.

Links and References

Discussion