Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Search → List Of Search

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Search resource with the List Of Search operation, it allows users to perform a search query across entities in the Halo PSA system and retrieve a list of matching results.

Common scenarios where this node is beneficial include:

  • Quickly finding records or entities in Halo PSA based on a search term.
  • Automating workflows that require fetching search results from Halo PSA to trigger further actions.
  • Aggregating or filtering data from Halo PSA by leveraging its search capabilities.

For example, a user might input a search string like "server outage" and specify how many results per entity type they want returned, then use the output to create tickets or alerts automatically.

Properties

Name Meaning
Count Per Entity Number of search results to return per entity type.
Search The search string or query to look for within the Halo PSA system.

Output

The node outputs an array of JSON objects representing the search results returned by the Halo PSA API. Each item corresponds to one input item processed and contains the raw JSON response from the API under the json field.

The structure of the JSON depends on the API's search response but typically includes details about matched entities such as their IDs, names, types, and other relevant metadata.

No binary data output is produced by this operation.

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 requests via custom headers.
  • No additional external dependencies beyond the Halo PSA API and n8n core modules.

Troubleshooting

  • No credentials returned!: This error indicates missing or misconfigured API credentials. Ensure the API key credential is properly set up in n8n.
  • Resource or Operation not found: Occurs if the specified resource or operation name does not match those defined in the node. Verify spelling and casing.
  • API request errors: Network issues, invalid parameters, or authentication failures will cause request errors. Check the API credentials, network connectivity, and parameter values.
  • If the node is set to continue on fail, errors will be returned in the output JSON under an error property instead of stopping execution.

Links and References

Discussion