Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Pdf Template Repository → List Of Pdf Template

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Pdf Template Repository resource and the List Of Pdf Template operation, it retrieves a list of PDF templates available in the repository. This is useful for scenarios where you want to dynamically fetch and display available PDF templates for further processing, such as generating reports or documents based on selected templates.

Practical examples include:

  • Automatically listing all PDF templates to allow users to select one for document generation.
  • Filtering PDF templates by license name or type to find specific templates matching certain criteria.

Properties

Name Meaning
Licencename Filter the list of PDF templates by the license name.
Type Filter the list of PDF templates by their type.

Both properties are sent as query parameters to the API when listing PDF templates, allowing filtering of results.

Output

The node outputs an array of JSON objects representing the PDF templates retrieved from the API. Each item corresponds to one PDF template and contains its details as returned by the Halo PSA API.

No binary data output is involved in this operation.

Example output structure (simplified):

[
  {
    "id": "template-id",
    "name": "Template Name",
    "type": "Template Type",
    "licenseName": "License Name",
    ...
  }
]

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects configuration of base URL, tenant ID, client ID, and client secret via credentials.
  • Uses HTTP requests to communicate with the Halo PSA REST API.

Troubleshooting

  • No credentials returned!: Ensure that valid API authentication credentials are configured in n8n for this node.
  • Resource or Operation not found: Verify that the resource and operation names are correctly set; they must match those supported by the node.
  • API request errors: Network issues, invalid query parameters, or insufficient permissions can cause API call failures. Check the error message returned in the node output for details.
  • If the node is set to continue on fail, errors will be included in the output JSON under an error field instead of stopping execution.

Links and References

Discussion