Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Schedule → List Of Schedule

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Schedule resource and the List Of Schedule operation, it retrieves a list of schedules from the Halo PSA system. This is useful in scenarios where you want to automate fetching schedule data for reporting, synchronization with other systems, or triggering workflows based on schedule information.

For example, you might use this node to:

  • Automatically retrieve all schedules for a given tenant to display in a dashboard.
  • Filter schedules by type or primary ID to process only relevant entries.
  • Include detailed information about each schedule when needed.

Properties

Name Meaning
Includedetails Optional parameter to specify whether to include detailed information in the response.
Primaryid Optional filter to specify the primary ID of the schedule(s) to retrieve.
Type Optional filter to specify the type of schedule(s) to retrieve.

These properties are sent as query parameters to the API request when listing schedules.

Output

The node outputs an array of JSON objects, each representing a schedule retrieved from the Halo PSA API. The exact structure depends on the API response but typically includes fields such as schedule ID, type, details (if requested), and other metadata.

If the Includedetails property is set, the output will contain more comprehensive information about each schedule.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects configuration of base URL, tenant identifier, client ID, and client secret via credentials.
  • Uses HTTP requests with appropriate headers (X-Tenant, X-HaloPSA-ClientId, X-HaloPSA-ClientSecret) to communicate with the Halo PSA API.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API authentication credentials. Ensure that valid credentials are configured in n8n before running the node.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("Schedule") and operation ("List Of Schedule") names are used.

  • API request errors
    Network issues, invalid query parameters, or authentication failures may cause errors during the API call. Check the credentials, network connectivity, and parameter values.

  • JSON parsing errors
    If additional JSON parameters are provided incorrectly, parsing may fail. Ensure any JSON input is well-formed.

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

Links and References

Discussion