Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Tree → Get One Tree

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a specific "Tree" resource. The "Get One Tree" operation fetches data for a single tree entity identified by its unique ID. It supports optional query parameters to include related agents, teams, and additional details in the response.

Typical use cases include:

  • Fetching hierarchical or organizational tree structures from Halo PSA.
  • Retrieving associated agents or teams linked to a particular tree.
  • Accessing extended metadata or details about a tree for reporting or automation workflows.

For example, you might use this node to get a tree's structure along with all agents assigned to it, enabling automated assignment or monitoring processes.

Properties

Name Meaning
Id The unique numeric identifier of the tree to retrieve.
Include Agents Optional flag to include agents related to the tree in the response.
Include Teams Optional flag to include teams related to the tree in the response.
Includedetails Optional flag to include additional detailed information about the tree in the response.

Note: The last three properties are sent as query parameters to the API and their exact accepted values depend on the API specification (likely boolean or specific strings).

Output

The node outputs an array of JSON objects, each representing the response from the Halo PSA API for the requested tree. The main output field is:

  • json: Contains the full JSON response from the API, including the tree data and any optionally included agents, teams, or details depending on the input parameters.

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 other external dependencies are required beyond the n8n environment and the Halo PSA API access.

Troubleshooting

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

  • Resource or Operation not found
    Indicates a mismatch or misconfiguration of the selected resource or operation. Verify that "Tree" and "Get One Tree" are correctly selected.

  • API request errors
    Errors from the API (e.g., invalid ID, unauthorized access) will be returned in the node output under an error property if "Continue On Fail" is enabled. Otherwise, they will cause the node to fail. Check the API documentation and credentials.

  • Invalid parameter types
    Ensure that the "Id" property is provided as a number and that optional flags are set according to expected API values.

Links and References

Discussion