Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Tree → List Of Tree

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve hierarchical organizational data represented as a "Tree". Specifically, the List Of Tree operation fetches a structured list of organizational units, departments, agents, teams, and managers according to specified filters and sorting options.

Typical use cases include:

  • Visualizing or exporting an organization's structure.
  • Filtering organizational units by agent departments, edit permissions, or types.
  • Paginating and searching through large organizational trees.
  • Including related entities such as agents, managers, and teams in the output.

For example, a user might want to list all departments where agents belong, including only those that can be edited, sorted by name, and paginated for display in a dashboard.

Properties

Name Meaning
Agent Departments Only Filter to include only departments associated with agents.
Can Edit Only Filter to include only entities that the user has permission to edit.
Count Limit the number of results returned.
Idonly Return only IDs instead of full objects.
Include Agents Include agent details within the tree nodes.
Include Managers Include manager details within the tree nodes.
Include Teams Include team details within the tree nodes.
Isorgchart Flag indicating if the tree should be formatted as an organizational chart.
Order Primary field to sort the results by (string).
Order 2 Secondary field to sort the results by (string).
Order 3 Tertiary field to sort the results by (string).
Order 4 Fourth-level field to sort the results by (string).
Order 5 Fifth-level field to sort the results by (string).
Orderdesc Boolean flag to indicate descending order for primary sort.
Orderdesc 2 Boolean flag to indicate descending order for secondary sort.
Orderdesc 3 Boolean flag to indicate descending order for tertiary sort.
Orderdesc 4 Boolean flag to indicate descending order for fourth-level sort.
Orderdesc 5 Boolean flag to indicate descending order for fifth-level sort.
Org Id Filter by specific organization ID.
Page No Page number for paginated results.
Page Size Number of items per page for pagination.
Pageinate Flag to enable or disable pagination.
Search Text search filter applied to the tree nodes.
Show All Flag to include all nodes regardless of other filters.
Type Filter by type of tree node (e.g., department, team).

Output

The node outputs JSON data representing the requested organizational tree structure. The exact shape depends on the filters and includes selected:

  • Organizational units (departments, teams).
  • Agents and managers if included.
  • Pagination metadata if pagination is enabled.

Each item in the output corresponds to a node in the organizational tree, potentially containing nested child nodes depending on the API response.

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 for the Halo PSA service.
  • Network connectivity to the Halo PSA API endpoint.

Troubleshooting

  • No credentials returned!: Ensure that the API authentication credentials are properly configured in n8n.
  • Resource or Operation not found: Verify that the Resource is set to "Tree" and Operation to "List Of Tree".
  • API request errors: Check network connectivity and validity of query parameters.
  • JSON parsing errors: If using advanced JSON parameters, ensure they are valid JSON strings.
  • Pagination issues: Confirm that page_no and page_size are set correctly when pagination is enabled.

If the node returns error messages from the API, review the message for hints about invalid parameters or permission issues.

Links and References

Discussion