Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Holidays → List Of Holidays

AI-generated

Overview

This node interacts with the Halo PSA API to retrieve a list of holidays based on specified criteria. It is useful for automating workflows that require fetching holiday data, such as scheduling, resource planning, or reporting within an organization.

Typical use cases include:

  • Retrieving approved holidays for specific agents or entities.
  • Filtering holidays within a date range.
  • Including or excluding certain approval statuses or related identifiers.

For example, you might use this node to get all approved holidays for a particular agent between two dates to adjust project timelines accordingly.

Properties

Name Meaning
Agent Id Filter holidays by a specific agent's identifier.
Approved Only When set, only returns holidays that have been approved.
End Date The end date to filter holidays up to (exclusive or inclusive depending on other flags).
Entity Filter holidays by a specific entity.
Include Apid Option to include additional related IDs in the response.
Inclusive End Whether the end date is inclusive in the filtering.
Inclusive Start Whether the start date is inclusive in the filtering.
My Approvals Filter holidays where the current user has approvals.
Start Date The start date to filter holidays from.
Workdayid Filter holidays by a specific workday identifier.

All these properties are sent as query parameters to the API when listing holidays.

Output

The node outputs JSON data representing the list of holidays returned by the Halo PSA API. Each item corresponds to a holiday record matching the query parameters.

The output structure directly reflects the API response and typically includes details such as holiday dates, approval status, associated agents or entities, and any other metadata provided by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node configuration must include the base URL, tenant identifier, client ID, and client secret for the Halo PSA service.
  • Uses HTTP requests with appropriate headers for authentication.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API authentication credentials. Ensure that the API key credential is properly configured in n8n.

  • Resource or Operation not found
    If the specified resource ("Holidays") or operation ("List Of Holidays") is missing or misspelled, the node will throw an error. Verify the resource and operation names.

  • API request errors
    Network issues, invalid query parameters, or authentication failures can cause the API request to fail. Check the credentials, endpoint URL, and parameter values.

  • JSON parsing errors
    If using JSON parameters, ensure they are valid JSON strings.

Using the "Continue On Fail" option can help handle errors gracefully in workflows.

Links and References

Discussion