TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node operation "Find One Calendar Channel" retrieves detailed information about a single calendar channel by its unique identifier. It is useful when you need to fetch specific calendar channel data, such as for displaying details in an application, synchronizing calendar channels, or performing further operations based on the channel's properties.

A practical example would be integrating with a calendar service where you want to display or process information about a particular calendar channel selected by the user.

Properties

Name Meaning
Id The unique identifier of the calendar channel to retrieve.
Depth Determines how much related nested data to include in the response:
- 0: Only primary object info.
- 1: Primary object + directly related objects.
- 2: Primary object + directly related objects + their related objects.

Output

The output JSON contains the detailed data of the requested calendar channel. Depending on the Depth parameter, this includes:

  • At depth 0: Basic information about the calendar channel itself.
  • At depth 1: The calendar channel plus its directly related objects (e.g., linked calendars or metadata).
  • At depth 2: The calendar channel, its directly related objects, and the related objects of those related objects, providing a more comprehensive dataset.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the external calendar service.
  • The node uses a base URL configured from credentials to connect to the calendar API.
  • The request expects JSON responses and sends JSON content-type headers.

Troubleshooting

  • Missing or invalid Id: If the Id property is empty or incorrect, the API will likely return an error indicating the object was not found. Ensure the correct calendar channel ID is provided.
  • Authentication errors: If the API key or authentication token is missing or invalid, the node will fail to connect. Verify that the API credentials are correctly set up in n8n.
  • Depth parameter misuse: Providing an unsupported depth value may cause unexpected results or errors. Use only 0, 1, or 2 as specified.
  • Network issues: Connectivity problems to the calendar API endpoint can cause timeouts or failures. Check network access and API availability.

Links and References

  • Refer to the calendar service API documentation for details on calendar channel objects and the meaning of nested related objects.
  • Consult n8n documentation on setting up API credentials and using HTTP request nodes for similar integrations.

Discussion