Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

KB Entry → List Of KB Entry

AI-generated

Overview

This node integrates with the Halo PSA API to list Knowledge Base (KB) entries. It allows users to retrieve filtered and paginated lists of KB articles from their Halo PSA system, which is useful for automating knowledge management workflows, syncing KB data, or displaying relevant articles in other systems.

Common scenarios include:

  • Fetching active or inactive KB articles based on various filters.
  • Searching KB entries by keywords, article type, language, or related tickets.
  • Paginating through large sets of KB articles.
  • Ordering results by multiple fields with ascending or descending options.

Practical example: A support team could use this node to automatically pull the latest active KB articles related to a specific client or device, then display them in a custom dashboard or send them via email.

Properties

Name Meaning
Activeinactive Filter on active/inactive assets - comma separated; first value true/false for active, second for inactive.
Advanced Search Advanced search query string to filter KB entries.
Articletype Filter on article type(s), comma separated.
Client Id Filter KB entries by a specific client ID (integer).
Count Number of KB entries to return in the response (integer).
Device Id Filter KB entries by a specific device ID (integer).
Faqlists Filter based on Knowledge Base Article FAQ lists (string, comma separated IDs).
Includeactive Include active KB entries in the response (boolean).
Includeinactive Include inactive KB entries in the response (boolean).
Key Filter based on the knowledge base key (string).
Language Code Filter KB entries by language code (string).
Language Override Language override parameter (string).
Needsreview Filter KB articles that are past their next review date (string).
Order Name of the field to order by first (string).
Order 2 Name of the field to order by second (string).
Order 3 Name of the field to order by third (string).
Order 4 Name of the field to order by fourth (string).
Order 5 Name of the field to order by fifth (string).
Orderdesc Whether to order ascending or descending on first order (boolean).
Orderdesc 2 Whether to order ascending or descending on second order (boolean).
Orderdesc 3 Whether to order ascending or descending on third order (boolean).
Orderdesc 4 Whether to order ascending or descending on fourth order (boolean).
Orderdesc 5 Whether to order ascending or descending on fifth order (boolean).
Organisation Id Filter KB articles belonging to a particular organisation (integer).
Page No Page number to return when using pagination (integer).
Page Size Size of the page when using pagination (integer).
Pageinate Whether to use pagination in the response (boolean).
Related To Filter based on the related Knowledge Base Article (integer).
Related To Ticket Filter based on the related ticket (integer).
Search Filter based on a search string (string).
Site Id Filter by the specified site (integer).
Type Filter based on the Knowledge Base Article type (integer).

Output

The node outputs an array of JSON objects representing the retrieved Knowledge Base entries. Each item corresponds to one KB entry as returned by the Halo PSA API. The exact structure depends on the API response but typically includes fields such as article ID, title, content, status (active/inactive), language, related tickets, and metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires connection to the Halo PSA API.
  • Requires user-provided credentials including base URL, tenant identifier, client ID, and client secret for authentication.
  • The node uses HTTP requests with appropriate headers to authenticate and query the API.
  • No additional external services beyond Halo PSA API are required.

Troubleshooting

  • No credentials returned!: This error indicates missing or invalid API 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 ("KB Entry") and operation ("List Of KB Entry") are selected.
  • API request errors: Network issues, incorrect parameters, or API limits may cause request failures. Check the error message returned in the node output for details.
  • JSON parsing errors: If using advanced JSON parameters, ensure that JSON strings are well-formed.
  • Pagination issues: When using pagination, ensure that page numbers and sizes are set correctly to avoid empty responses.

Links and References

Discussion