3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "List Holiday" operation under the "Holidays" resource is designed to retrieve a list of holiday entries from an external service. This node is useful in scenarios where you need to fetch and process holiday data, such as integrating holiday calendars into workflows, automating scheduling around holidays, or generating reports that consider public holidays.

For example, you might use this node to:

  • Retrieve upcoming holidays to adjust automated email campaigns.
  • Fetch holiday data to block out dates in booking systems.
  • Aggregate holiday information for HR attendance tracking.

Properties

Name Meaning
Options A collection of optional query parameters to customize the list of holidays returned:
- Top ($top) Limits the number of items returned to the first n entries.
- Skip ($skip) Skips the first n items in the result set, useful for pagination.
- Search ($search) Searches items by phrases; supports automatic quoting if the phrase contains spaces.
- Filter ($filter) Filters items based on property values using expressions (e.g., State eq 'Connected').
- Count ($count) Includes the count of total items matching the query when set to true.
- Orderby ($orderby) Orders the results by specified properties (e.g., Name desc, CreatedAt asc).
- Select ($select) Selects specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expands related entities to include additional linked data (e.g., RelatedEntity1).

Output

The node outputs JSON data containing the list of holidays retrieved from the external API. Each item in the output typically represents a holiday with its associated properties as defined by the API response and filtered/selected according to the input options.

If binary data were involved (e.g., attachments), it would be included in a separate binary field, but this operation focuses on JSON data only.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external service.
  • The base URL and headers are set dynamically based on credentials.
  • The node depends on the external API supporting OData-like query parameters ($top, $skip, $filter, etc.) for filtering and pagination.

Troubleshooting

  • Empty Results: If no holidays are returned, verify the filter and search parameters are correct and match existing data.
  • Authentication Errors: Ensure the API key or authentication token is valid and has sufficient permissions.
  • Invalid Query Parameters: Incorrect syntax in filter, orderby, or other query fields may cause errors; check the API documentation for correct usage.
  • Network Issues: Confirm the base URL is correctly configured and reachable from the n8n instance.

Links and References

  • OData Query Options
  • Refer to the external API's official documentation for detailed descriptions of supported query parameters and response formats.

Discussion