Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

FAQ List Head → List Of FAQ List Head

AI-generated

Overview

This node interacts with the "FAQ List Head" resource of the Halo PSA API to retrieve a list of FAQ list heads based on specified query parameters. It is useful for scenarios where you want to fetch structured FAQ categories or groups, potentially filtered by various criteria such as organizational context, hierarchy level, or type.

Practical examples include:

  • Retrieving all FAQ groups within an organization.
  • Fetching only top-level FAQ categories (e.g., those without parents).
  • Filtering FAQ lists by their type or hierarchical level to display in a knowledge base or support portal.

Properties

Name Meaning
Allgroups Filter to include all groups.
Endoftreeonly Filter to include only FAQ list heads at the end of the tree (leaf nodes).
Level Filter by the hierarchical level of the FAQ list head.
Organisation Id Filter FAQ list heads belonging to a specific organization.
Parent Id Filter FAQ list heads that have a specific parent ID (to get children of a category).
Showcounts Option to include counts of FAQs within each list head.
Type Filter FAQ list heads by their type.

Output

The node outputs JSON data representing the list of FAQ list heads retrieved from the API. Each item in the output corresponds to one FAQ list head and includes its properties as returned by the API.

If the API supports it, the output may also include counts of FAQs per list head when the Showcounts property is used.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses the base URL, tenant identifier, client ID, and client secret from the credentials to authenticate requests.
  • No additional external dependencies beyond the configured API credentials are needed.

Troubleshooting

  • No credentials returned!: This error occurs if the node cannot find or access the required API authentication credentials. Ensure that valid credentials are configured in n8n before running the node.
  • Resource or Operation not found: If the specified resource or operation does not exist, verify that the correct resource ("FAQ List Head") and operation ("List Of FAQ List Head") are selected.
  • 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 query parameters or JSON input fields, ensure the JSON syntax is correct.

Links and References

Discussion