HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions68

Overview

This node interacts with the HaloPSA API to retrieve detailed information about a specific ticket by its ID. It is designed for scenarios where users need to fetch comprehensive ticket data, including optional related details such as agent info, auditing logs, linked objects, appointments, and more. This can be useful in IT service management workflows, customer support automation, or reporting systems that require up-to-date ticket information.

For example, a user might want to:

  • Retrieve a ticket's full details along with the assigned agent's information.
  • Fetch tickets filtered by email or subject.
  • Include audit trails or child ticket IDs for deeper analysis.
  • Use debug mode to troubleshoot API responses.

Properties

Name Meaning
Ticket ID The unique numeric identifier of the ticket to retrieve.
Options A collection of optional parameters to customize the ticket retrieval:
- AMail Entry ID Filter or specify an AMail entry ID parameter.
- Assigned To Filter tickets by the assigned agent's numeric ID.
- Consignable Lines Boolean flag to include consignable lines in the response.
- Debug Boolean flag to include debug information in the API response.
- Do Database Lookup Boolean flag indicating whether to perform a database lookup during retrieval.
- Email Filter tickets by an email address.
- Include Agent Details Boolean flag to include detailed information about the assigned agent.
- Include Auditing Boolean flag to include auditing information (e.g., change logs) in the response.
- Include Child IDs Boolean flag to include IDs of child tickets related to the main ticket.
- Include Details Boolean flag to include extra detailed objects in the response (default true).
- Include Last Action Boolean flag to include information about the last action taken on the ticket.
- Include Last Appointment Boolean flag to include details of the last appointment related to the ticket.
- Include Linked Objects Boolean flag to include objects linked to the ticket.
- Include Next Appointment Boolean flag to include details of the next scheduled appointment.
- Include Parent Change Info Boolean flag to include information about changes to the parent ticket.
- Include Parent Subject Boolean flag to include the subject of the parent ticket.
- Include Seen By Boolean flag to include information about who has seen the ticket.
- Is Detail Screen Boolean flag indicating if the request is for a detail screen view.
- Is Halo Link Boolean flag indicating if the request is a Halo link request.
- Is Portal Boolean flag indicating if the request is made from portal access.
- Is Preview Boolean flag indicating if the request is for preview mode.
- Is Teams Boolean flag to return only tickets related to teams.
- No Cache Boolean flag to disable caching of the response.
- Subject Filter tickets by subject text.
- Ticket ID Only Boolean flag to include only details directly related to the specified ticket ID in the response.
- UTC Offset Numeric value to add an offset to UTC dates in the response, supporting decimal precision.

Output

The node outputs JSON data representing the retrieved ticket and its associated information based on the selected options. The structure typically includes:

  • Core ticket fields such as ID, subject, status, priority, description, creation and update timestamps.
  • Optional nested objects depending on flags set, e.g., agent details, auditing logs, linked objects, appointments, child ticket IDs.
  • Debug information if enabled.

If binary data were involved (not indicated here), it would represent attachments or files related to the ticket, but this node focuses on JSON data output.

Dependencies

  • Requires connection to the HaloPSA API using an API key credential configured in n8n.
  • Network access to the HaloPSA service endpoint.
  • Proper permissions on the API key to read ticket data.
  • No additional external dependencies beyond the API and n8n environment.

Troubleshooting

  • Common Issues:

    • Invalid or missing Ticket ID will cause the API to return errors or empty results.
    • Insufficient API permissions may result in authorization errors.
    • Network connectivity issues can prevent successful API calls.
    • Using incompatible option combinations might lead to unexpected or incomplete data.

  • Error Messages:

    • "Ticket not found" — Verify the Ticket ID is correct and exists.
    • "Unauthorized" or "Forbidden" — Check API credentials and permissions.
    • "Timeout" or "Network Error" — Ensure network connectivity and API availability.
    • "Invalid parameter" — Review option values for correctness and supported types.

  • Resolution Tips:

    • Double-check all input parameters before execution.
    • Enable debug option to get detailed API response for troubleshooting.
    • Confirm API key validity and scope.
    • Test API connectivity outside n8n if needed.

Links and References

Discussion