Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Module Setup → List Of Module Setup

AI-generated

Overview

This node integrates with the Halo PSA API, allowing users to interact programmatically with various resources and operations provided by the Halo PSA platform. It is designed to perform RESTful API calls (GET, POST, PUT, PATCH) to manage or retrieve data related to different Halo PSA modules.

A common use case for this node is automating tasks such as listing module setups, creating attachments, or updating records within Halo PSA without manual intervention. For example, a user might list all module setups filtered by configuration status or enabled/disabled state, enabling dynamic workflows based on system configurations.

Properties

Name Meaning
Isconfig Query parameter to filter module setups based on their configuration status.
Showdisabled Query parameter to include or exclude disabled module setups in the list.
Showenabled Query parameter to include or exclude enabled module setups in the list.

These properties are sent as query parameters when performing the "List Of Module Setup" operation under the "Module Setup" resource.

Output

The node outputs an array of JSON objects corresponding to the response from the Halo PSA API. Each item in the output contains a json field representing the API response data for the respective input item processed.

If the operation involves binary data (e.g., uploading attachments), the node handles binary content accordingly, but for the "List Of Module Setup" operation, the output is purely JSON data describing the module setups.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate API requests via custom headers.
  • No additional external dependencies beyond the Halo PSA API and n8n's HTTP request capabilities.

Troubleshooting

  • No credentials returned!: This error occurs if the node cannot retrieve the required API credentials. Ensure that the API key credential is properly configured in n8n.
  • Resource or Operation not found: Indicates that the specified resource or operation does not exist in the node's configuration. Verify that the correct resource ("Module Setup") and operation ("List Of Module Setup") names are used.
  • API request errors: If the API returns an error (e.g., authentication failure, invalid parameters), the node will throw an error unless "Continue On Fail" is enabled, in which case it outputs the error message in the JSON response.
  • JSON parsing errors: When using JSON parameters, ensure that any JSON strings provided are correctly formatted to avoid parsing exceptions.

Links and References

Discussion