Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Licence → List Of Licence

AI-generated

Overview

This node integrates with the Halo PSA API to list licences based on various filtering and sorting criteria. It is useful for retrieving detailed licence information from a Halo PSA system, enabling automation workflows that require licence data management or reporting.

Typical use cases include:

  • Fetching all licences associated with a specific client or site.
  • Filtering licences by type or status (active/inactive).
  • Paginating through large sets of licences.
  • Sorting licences by multiple fields in ascending or descending order.
  • Searching licences using keywords.

For example, you could automate a report that lists all active licences for a particular client, sorted by expiry date, or integrate licence data into a CRM or asset management system.

Properties

Name Meaning
Client Id Filter licences by the client identifier.
Count Limit the number of licences returned.
Includeinactive Whether to include inactive licences in the results.
Licence Type Filter licences by their type.
Order Primary field to sort the licences by (string).
Order 2 Secondary field to sort the licences by (string).
Order 3 Tertiary field to sort the licences by (string).
Order 4 Fourth-level field to sort the licences by (string).
Order 5 Fifth-level field to sort the licences by (string).
Orderdesc Whether to sort the primary order field in descending order (boolean-like).
Orderdesc 2 Whether to sort the secondary order field in descending order.
Orderdesc 3 Whether to sort the tertiary order field in descending order.
Orderdesc 4 Whether to sort the fourth-level order field in descending order.
Orderdesc 5 Whether to sort the fifth-level order field in descending order.
Page No The page number to retrieve when paginating results.
Page Size Number of licences per page.
Pageinate Enable or disable pagination (likely boolean-like).
Search Search string to filter licences by keyword.
Site Id Filter licences by site identifier.
Tenant Id Filter licences by tenant identifier.
Toplevelid Filter licences by top-level identifier (context-specific).

Output

The node outputs an array of JSON objects representing licences retrieved from the Halo PSA API. Each item corresponds to one licence record with its associated fields as returned by the API.

If the operation involves binary data (not applicable here), it would be included in the binary property of the output items, but this operation only returns JSON data.

Dependencies

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

Troubleshooting

  • No credentials returned!: This error occurs if the node cannot find or access the required API authentication credentials. Ensure the API key credential is properly configured in n8n.
  • Resource or Operation not found: If the specified resource or operation does not exist, verify that the correct resource ("Licence") and operation ("List Of Licence") are selected.
  • API request errors: Network issues, invalid parameters, or permission problems may cause API request failures. Check the error message returned in the node output for details.
  • Pagination issues: Incorrect page numbers or sizes may result in empty responses. Adjust pagination parameters accordingly.
  • Invalid query parameters: Passing unsupported or malformed query parameters can cause API errors. Use only supported properties as defined.

Links and References

Discussion