Actions17
- Announcement Actions
- Employee Actions
- Holiday Actions
- Leave Request Actions
- Planning Actions
Overview
The node interacts with an external Pulse API to manage office-related data, specifically focusing on the "Holiday" resource when performing the "Get Holiday List" operation. It retrieves a list of holidays based on optional filtering, sorting, pagination, and field selection parameters.
This node is beneficial in scenarios where users need to automate fetching holiday schedules from an organization's system for use in workflows such as calendar integrations, employee scheduling, or reporting.
Practical example:
A workflow that automatically fetches the upcoming holidays each month to update a shared team calendar or notify employees about upcoming days off.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | Optional parameters to customize the request: |
| - Sort | The sort order to apply to the holiday list (e.g., ascending or descending by date). |
| - Page Number | The page number for paginated results (default is 1). |
| - Page Size | The number of items per page in the paginated response (default is 10). |
| - Filters | Key-value pairs to filter the holiday list, where keys are filter fields (e.g., organization_id) and values are comma-separated filter values. |
| - Fields | Specific fields to include in the response, allowing selection of nested fields by key and comma-separated field names. |
Output
The output is a JSON object containing the list of holidays retrieved from the Pulse API. Each item in the list represents a holiday with its associated details as returned by the API, which may include properties like holiday name, date, description, and other metadata depending on the selected fields.
No binary data output is produced by this operation.
Dependencies
- Requires connection to the Pulse API via an API key credential configured in n8n.
- The node depends on the Pulse API helper utilities bundled within the node's codebase to perform authenticated requests.
- Proper API credentials must be set up in n8n to authorize requests.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Invalid filter keys or values may result in empty responses or errors from the API.
- Pagination parameters out of range might lead to no results being returned.
- Specifying invalid field keys could cause the API to ignore those fields or return errors.
Error messages:
"Unknown operation: "getHolidayList" is not supported for resource "holiday"!"— This indicates a misconfiguration of the operation or resource; ensure the correct operation and resource are selected.- API authentication errors typically indicate invalid or missing API credentials; verify the API key setup.
- Network or timeout errors suggest connectivity issues; check network access and API availability.
Links and References
- Pulse API Documentation (replace with actual URL if available)
- n8n documentation on Creating Custom Nodes
- General API pagination and filtering best practices: REST API Pagination