TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node operation "Find One Favorite Folder" retrieves a single favorite folder object by its unique identifier. It is useful when you need to fetch detailed information about a specific favorite folder, including optionally related nested objects depending on the depth level specified.

Practical examples include:

  • Fetching metadata and contents of a particular favorite folder for display or processing.
  • Retrieving nested related data such as items within the folder or subfolders up to a certain depth.
  • Integrating with other workflows that require precise folder details from a favorites collection.

Properties

Name Meaning
Id The unique identifier of the favorite folder to retrieve. This is required to specify which folder to find.
Depth Determines how much nested related data to include in the response:
- 0: Only the folder's own data.
- 1: Folder plus directly related objects.
- 2: Folder, directly related objects, and their related objects.

Output

The output JSON contains the data of the found favorite folder object. Depending on the Depth property, this includes:

  • At depth 0: Basic information about the favorite folder itself.
  • At depth 1: The folder plus its directly related objects (e.g., immediate child items or metadata).
  • At depth 2: The folder, its direct relations, and the relations of those related objects (deeper nested data).

No binary data output is indicated for this operation.

Dependencies

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

Troubleshooting

  • Missing or invalid Id: If the Id property is empty or incorrect, the node will fail to find the folder. Ensure the correct folder ID is provided.
  • Authentication errors: If the API key or domain credentials are missing or invalid, the request will be unauthorized. Verify credentials configuration.
  • Depth value issues: Providing a depth outside the allowed range (0, 1, 2) may cause unexpected results or errors. Use only the supported options.
  • Network or API errors: Connectivity problems or API downtime can cause failures. Check network access and API status.

Links and References

Discussion