Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

View Lists → List Of View Lists

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve and manipulate data related to various resources within the Halo PSA system. Specifically, for the View Lists resource and the List Of View Lists operation, it fetches a list of view lists based on provided query parameters.

Typical use cases include:

  • Retrieving filtered or customized views of ticket lists or other categorized data in Halo PSA.
  • Automating reporting or dashboard updates by fetching current view lists.
  • Integrating Halo PSA views into workflows that require dynamic access to these lists.

For example, you might use this node to get all view lists associated with a particular domain or ticket area, optionally filtering by whether the list is global, tree-structured, or includes counts.

Properties

Name Meaning
Connectedinstance Id Filter by the ID of the connected instance.
Domain Filter by domain (string).
Globalonly Filter to only include global view lists (boolean-like).
Istree Filter to only include tree-structured view lists (boolean-like).
Showall Option to show all view lists (boolean-like).
Showallforteam Option to show all view lists for a team (boolean-like).
Showallfortech Option to show all view lists for a technician (boolean-like).
Showcounts Option to include counts in the response (boolean-like).
Ticketarea Id Filter by the ID of the ticket area.
Type Filter by type (string).

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

Output

The node outputs an array of JSON objects representing the view lists retrieved from the Halo PSA API. Each item corresponds to one view list and contains fields as returned by the API, which may include identifiers, names, types, counts, hierarchical structure indicators, and other metadata depending on the filters applied.

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 to communicate with the Halo PSA REST API.

Troubleshooting

  • No credentials returned!: This error occurs if the required API authentication credentials are not configured or accessible. Ensure that the API key credential is properly set up in n8n.
  • Resource or Operation not found: If the specified resource or operation does not exist, verify that the correct resource ("View Lists") and operation ("List Of View Lists") names are used.
  • API request errors: Network issues, invalid query parameters, or permission problems can cause API request failures. Check the error message returned in the node output for details.
  • JSON parsing errors: If using advanced JSON parameters, ensure they are valid JSON strings.

To resolve most issues, verify credentials, parameter correctness, and network connectivity.

Links and References

Discussion