TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node interacts with the Twenty API to retrieve detailed information about a specific blocklist by its unique identifier. It is useful when you need to fetch data about one particular blocklist, including optionally related nested objects depending on the depth level specified. Practical use cases include monitoring or managing blocklists in security or content filtering applications where precise blocklist details are required.

Properties

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

Output

The node outputs JSON data representing the blocklist object retrieved from the API. The structure includes the blocklist's properties and, depending on the Depth parameter, may also include nested related objects up to two levels deep. No binary data output is indicated.

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 communication (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Missing or invalid Id: Since the Id property is required, omitting it or providing an incorrect value will likely cause the API call to fail or return no results. Ensure the correct blocklist ID is provided.
  • Authentication errors: If the API key credential is missing or invalid, the node will not be able to authenticate with the Twenty API. Verify that the API key is correctly set up in n8n credentials.
  • Invalid Depth values: Although the node restricts depth options, passing unsupported values programmatically might cause unexpected responses or errors.
  • Network issues: Connectivity problems to the API endpoint will result in request failures. Check network access and API availability.

Links and References

Discussion