Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Faults → Get One Faults

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a specific fault (ticket) by its ID. It is designed to fetch one fault record, optionally including various related details such as auditing data, linked objects, appointments, and more, depending on user-selected options.

Common scenarios for this node include:

  • Fetching detailed fault/ticket information for customer support or IT service management workflows.
  • Retrieving enriched fault data with related entities like assigned agents, audit trails, or linked tickets.
  • Automating reporting or notification processes based on fault status or attributes.

For example, a user might use this node to get all relevant details of a fault ticket before sending an update email or creating a task in another system.

Properties

Name Meaning
Id The unique numeric identifier of the fault to retrieve. (Required)
Amailentryid Filter/query parameter for the mail entry ID associated with the fault.
Assignedto Filter/query parameter specifying the user or agent assigned to the fault.
Consignablelines Filter/query parameter related to consignable lines (specific meaning depends on API).
Debug Boolean flag to include debug information in the response.
Dodatabaselookup Query option to perform database lookup (specific meaning depends on API).
Email Filter/query parameter for email address related to the fault.
Include Auditing Boolean flag to include auditing information in the response.
Includeagent Flag to include agent details in the response.
Includechildids Flag to include child fault IDs in the response.
Includedetails Boolean flag to include extra objects/details in the response.
Includelastaction Flag to include the last action performed on the fault.
Includelastappointment Boolean flag to include the last appointment related to the fault.
Includelinkedobjects Boolean flag to include linked objects in the response.
Includenextappointment Boolean flag to include the next appointment related to the fault.
Includeparentchangeinfo Flag to include change info from parent faults.
Includeparentsubject Flag to include the subject of the parent fault.
Includeseenby Flag to include information about who has seen the fault.
Is Portal Flag indicating if the request is from a portal context.
Isdetailscreen Flag indicating if the request is for a detail screen view.
Ishalolink Flag related to Halo link integration (specific meaning depends on API).
Ispreview Flag indicating if the request is a preview.
Isteams Boolean flag to return only team-related tickets.
Nocache Boolean flag to disable caching of the response.
Subject Filter/query parameter for the fault's subject text.
Ticketidonly Boolean flag to include only details related to the specified ticket.
Utcoffset Query parameter specifying UTC offset for date/time fields.

Output

The node outputs JSON data representing the fault record retrieved from the Halo PSA API. The structure includes the fault's main properties and, depending on selected options, may also contain nested objects such as:

  • Audit logs
  • Agent details
  • Child fault IDs
  • Linked objects
  • Appointment details (last and next)
  • Parent fault information
  • Seen-by user information

If binary data were involved (not applicable here), it would be summarized accordingly, but this operation deals solely with JSON responses.

Dependencies

  • Requires an active connection to the Halo PSA API.
  • Needs credentials providing base URL, tenant identifier, client ID, and client secret for authentication.
  • The node uses HTTP requests with appropriate headers to communicate with the API.
  • No additional external services are required beyond the Halo PSA API.

Troubleshooting

  • No credentials returned!: Ensure that valid API credentials are configured in n8n for the Halo PSA connection.
  • Resource or Operation not found: Verify that the resource "Faults" and operation "Get One Faults" are correctly selected.
  • Invalid or missing Id: The "Id" property is required; ensure it is provided and is a valid number.
  • API errors: If the API returns errors, check network connectivity, credential validity, and that the fault ID exists.
  • JSON parsing errors: When using advanced query parameters or JSON bodies, ensure JSON syntax is correct.
  • Enable "Continue On Fail" in the node settings to handle errors gracefully during batch executions.

Links and References

Discussion