TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node interacts with the "Favorites" resource of the Twenty API to retrieve a single favorite item by its unique identifier. It is useful when you want to fetch detailed information about a specific favorite, including optionally related nested objects depending on the depth level specified.

Practical examples include:

  • Retrieving a user's saved favorite post or comment for display or further processing.
  • Fetching detailed metadata about a favorite item along with related entities such as the user who favorited it or associated content.

Properties

Name Meaning
Id The unique identifier of the favorite object to retrieve. This is required.
Depth Determines how much related nested data to include in the response:
- 0: Only the primary favorite object.
- 1: Primary object plus directly related objects.
- 2: Primary object, directly related objects, and their related objects.

Output

The output JSON contains the data of the requested favorite object. Depending on the Depth parameter, this can include just the favorite's own fields or also nested related objects up to two levels deep. The structure will reflect the favorite's properties and any included related entities.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authenticating requests to the Twenty API.
  • The node uses the base URL configured in the credentials.
  • The node depends on the bundled OpenAPI specification (twenty-v1.0.3-openapi.json) and the @devlikeapro/n8n-openapi-node package for request building.

Troubleshooting

  • Missing or invalid Id: Since the Id property is required, omitting it or providing an incorrect value will likely cause an error or no data returned.
  • Invalid Depth value: Using a depth outside the allowed options (0, 1, 2) may result in unexpected responses or errors.
  • Authentication errors: Ensure the API key credential is correctly set up and has proper permissions.
  • Network or API errors: Check connectivity and API status if requests fail.

Links and References

  • Twenty API Documentation (assumed official docs for the API)
  • n8n OpenAPI Node integration documentation (for understanding how OpenAPI specs are used in n8n nodes)

Discussion