TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node allows you to retrieve a single "Note Target" object by its unique identifier. It is useful when you need detailed information about a specific note target within your system, such as fetching metadata or related entities connected to that note target.

Common scenarios include:

  • Fetching details of a particular note target for display or processing.
  • Retrieving nested related objects up to a specified depth to understand relationships or dependencies.
  • Integrating with other workflows that require precise data about one note target.

For example, you might use this node to get the full details of a note target including its directly related objects (depth 1) or even further nested relations (depth 2), depending on your needs.

Properties

Name Meaning
Id The unique identifier of the note target object you want to retrieve. This is required.
Depth Determines how many levels of nested related objects to include in the response:
- 0: Only the primary note target object information.
- 1: The primary object plus its directly related objects (no further nesting).
- 2: The primary object, its directly related objects, and their related objects (two levels deep).

Output

The output JSON contains the retrieved note target object with fields corresponding to its properties and optionally nested related objects depending on the Depth parameter.

  • At depth 0, only the main note target's data is returned.
  • At depth 1, the output includes the note target and its immediate related objects.
  • At depth 2, the output extends to related objects of those related objects, providing a deeper hierarchical structure.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential to authenticate requests against the Twenty API service.
  • 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: Since the Id property is required, omitting it or providing an incorrect value will likely cause errors or empty responses. Ensure the Id is correct and exists in the system.
  • Invalid Depth value: Only values 0, 1, or 2 are supported. Providing other values may result in unexpected behavior or errors.
  • Authentication errors: If the API key or domain credentials are misconfigured, the node will fail to connect. Verify credentials are correctly set.
  • API rate limits or downtime: External API issues can cause failures; check the service status if persistent errors occur.

Links and References

Discussion