HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions68

Overview

This node interacts with the HaloPSA API to retrieve multiple ticket types based on various filtering criteria. It is useful in scenarios where you need to list or analyze different categories of tickets available in your service management system, such as for reporting, automation workflows, or integration with other tools.

For example, you might use this node to:

  • Fetch all active ticket types that agents can select.
  • Retrieve ticket types filtered by access control level or associated groups.
  • Get counts of tickets per type for dashboard metrics.
  • Filter ticket types visible to anonymous users or specific user roles.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of results to return (used if "Return All" is false).
Filters Collection of filters to narrow down the ticket types returned:
- Access Control Level Filter ticket types by their access control level (number).
- Anonymous and User Filter ticket types viewable by anonymous users (boolean).
- Can Agents Select Filter ticket types that agents are allowed to select (boolean).
- Can Create Only Filter ticket types that are created (boolean).
- Can Edit Only Filter ticket types that can be edited (boolean).
- Can User Create Filter ticket types that users can create (boolean).
- Client ID Filter ticket types by a particular customer/client ID (number).
- Domain Filter domain context for counts, e.g., tickets, opportunities, projects (string).
- Group ID Filter by ticket type group ID (number).
- Include Current Include this ticket type in the response, used alongside create/edit filters (number).
- Include Mandatory Field Check Whether to include mandatory field check information in the response (boolean).
- Is Quick Time Dropdown Filter ticket types that display on quick time dropdowns (boolean).
- ITIL Type Filter by ITIL type (number).
- Outcome ID Filter by outcome ID (number).
- Search Tickets Filter ticket types based on tickets matching this search string (string).
- Show All Admin override to show all ticket types, ignoring ticket permissions (boolean).
- Show Counts Whether to include the count of tickets in the response (boolean).
- Show Inactive Whether to include inactive ticket types in the response (boolean).
- Sprints Only Filter to show only sprint ticket types (boolean).
- Ticket Area ID Ticket area filter used only when showing counts (number).
- User Only Filter ticket types that the current user can see (boolean).
- View ID Ticket view filter used only when showing counts (number).

Output

The node outputs JSON data representing an array of ticket types matching the specified filters. Each ticket type object typically includes fields such as its ID, name, description, and possibly additional metadata like counts or access levels depending on the filters applied.

If the node supports binary data output (not indicated here), it would represent attachments or related files, but this node primarily returns structured JSON data about ticket types.

Dependencies

  • Requires connection to the HaloPSA API with appropriate authentication via an API key credential.
  • The node expects the HaloPSA API endpoint to be reachable and properly configured in n8n credentials.
  • No additional external dependencies beyond the API and n8n environment.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using incompatible filter values (e.g., invalid IDs or types) may result in empty responses or errors.
    • Network connectivity issues to the HaloPSA API endpoint can cause request failures.

  • Error Messages:

    • Authentication errors indicate invalid or expired API keys; verify and update credentials.
    • Validation errors on filters suggest incorrect parameter types or unsupported values; review input properties.
    • Timeout or network errors require checking API availability and network settings.

Links and References

Discussion