TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node allows you to retrieve detailed information about a specific message folder by its unique identifier. It is useful when you need to fetch metadata or properties of a single message folder within a messaging or communication platform. For example, you might use this node to get the details of an inbox, archive, or custom folder to display in a dashboard or to process messages contained within that folder.

Properties

Name Meaning
Id The unique identifier of the message folder you want to find. This is a required string input.
Depth Determines how much related nested data to include in the response:
- 0: Only the primary message folder's information.
- 1: Includes the primary folder and its directly related objects.
- 2: Includes the primary folder, its related objects, and their related objects as well.

Output

The output JSON contains the data of the requested message folder. Depending on the selected depth, it may include nested related objects such as subfolders or linked entities. The structure typically includes folder metadata like name, id, creation date, and possibly nested related objects up to the specified depth level.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the external service providing message folder data.
  • The node uses a base URL configured via credentials to connect to the relevant API endpoint.
  • No additional environment variables are explicitly required.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent folder ID will likely result in an error or empty response.
    • Insufficient permissions or missing API authentication can cause authorization errors.
    • Setting an unsupported depth value (other than 0, 1, or 2) may lead to unexpected results or errors.
  • Error messages:

    • "Folder not found": Verify the folder ID is correct and exists.
    • "Unauthorized" or "Authentication failed": Check that the API key credential is correctly configured and has necessary permissions.
    • "Invalid parameter": Ensure the depth parameter is one of the allowed values (0, 1, 2).

Links and References

  • Refer to the external API documentation of the messaging platform for detailed schema of message folders and related objects.
  • n8n documentation on using API key credentials and configuring nodes for REST API calls.

Discussion