TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node interacts with the "View Filters" resource of the Twenty API, specifically supporting the operation to create multiple view filters at once ("Create Many View Filters"). It allows users to send a batch of filter definitions to the API, which can be useful for setting up or updating multiple filters in one request. This is beneficial in scenarios where you want to automate the configuration of views or dashboards by applying several filters programmatically, saving time compared to manual setup.

For example, a user might prepare a JSON array of filter criteria and use this node to apply all those filters simultaneously to a project management or analytics tool that supports the Twenty API.

Properties

Name Meaning
Depth Determines how much related nested data to include in the response:
- 0: Only the primary object's information.
- 1: Primary object plus its directly related objects.
- 2: Primary object, its related objects, and their related objects.
Body The JSON body containing the view filters to create. This should be a valid JSON string representing the filters' details, e.g., field metadata IDs and other filter parameters.

Output

The node outputs JSON data representing the result of the "Create Many View Filters" API call. This typically includes the created view filter objects with their properties as returned by the API, reflecting the newly created filters and any associated metadata.

No binary data output is indicated or expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the Twenty API.
  • The node uses the base URL provided by the user's credentials configuration.
  • The node expects the Twenty API to be accessible and properly configured to accept batch creation of view filters.

Troubleshooting

  • Invalid JSON in Body: If the JSON provided in the "Body" property is malformed, the node will fail. Ensure the JSON is correctly formatted.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key or token is correctly set up in n8n credentials.
  • API Response Errors: If the API rejects the request due to invalid filter data or unsupported depth values, check the API documentation for correct parameter usage.
  • Network Issues: Connectivity problems to the Twenty API endpoint will cause request failures. Confirm network access and endpoint availability.

Links and References

Discussion