Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Faults → List Of Faults

AI-generated

Overview

This node interacts with the Halo PSA API to retrieve a list of faults (tickets) based on various filtering criteria. It is designed to fetch detailed fault/ticket data from the system, supporting extensive query parameters to tailor the results precisely.

Common scenarios where this node is beneficial include:

  • Retrieving tickets assigned to specific agents or teams.
  • Filtering faults by status, priority, category, or date ranges.
  • Extracting tickets related to particular clients, assets, or contracts.
  • Fetching only open, closed, or unlinked tickets.
  • Including additional details such as agent info, contract details, SLA timers, and more in the response.

Practical examples:

  • A support team wants to list all open faults assigned to a particular agent within the last month.
  • A manager needs to generate a report of all closed tickets for a specific client filtered by priority and category.
  • An automation workflow requires fetching tickets that have attachments and are flagged for review.

Properties

Name Meaning
Advanced Search Custom advanced search string to filter faults.
Agent Array of agent IDs to filter tickets assigned to those agents.
Agent Id Single agent ID to filter tickets assigned to that agent.
Alerttype Include alert type field in the response; e.g., 'ninjarmm'.
Asset Id Filter tickets by a specific asset ID.
Awaitinginput Filter based on awaiting input status.
Billableonly Filter to return only billable tickets.
Billing Date Filter tickets by billing date.
Billing Type Filter tickets by billing type.
Calendar Enddate Filter actions occurring before this calendar date.
Calendar Startdate Filter actions occurring after this calendar date.
Category 1-4 Arrays of category IDs to filter tickets by multiple category levels.
Checkmyticketsonly Filter to check only user's tickets.
Client Id Filter tickets by a specific client ID.
Client Ids Array of client IDs to filter tickets.
Client Ref Filter tickets by client reference string.
Closed Only Return only closed tickets.
Columns Id Column profile ID to filter columns in the response.
Contract Id Filter tickets by contract ID.
Contract Period Filter tickets by contract period.
Count Number of tickets to return.
Datesearch Date field to search against, e.g., 'dateoccured' (opened), 'datecleared' (closed).
Debug Enable debug mode for the request.
Default Columns Include only default columns in the response.
Deleted Filter deleted tickets.
Domain Filter ticket areas: 'reqs' (requests), 'opps' (opportunities), 'prjs' (projects).
Enddate End date for date range filters.
Enddatetime Include project end date and time details.
Excludeslacalcs Exclude SLA calculation details.
Excludethese Array of fault IDs to exclude from results.
Excludetickettypeallowall Exclude ticket type allow all details.
Extraportalfilter Filter on extraportalfilter field, e.g., 'MyTicketsOnly', 'MyClientTickets'.
Facebook Id Filter by Facebook ID.
Fetchgrandchildren Include grandchildren tickets.
Flagged Array of flagged ticket IDs to filter.
Followedandagents Array of agent and follower IDs to filter tickets.
Ignoremilestonerestriction Ignore milestone restrictions.
Includeaccountmanager Include account manager details.
Includeagent Include agent details.
Includeallopen Include all open tickets.
Includeappointmentid Include appointment ID in response.
Includeapproval Filter on approval tickets (1 = approval, 0 = not approval).
Includeassetkeyfield Include asset key field.
Includeassettype Include asset type details.
Includebreached Array of breached ticket IDs to filter.
Includebudgettype Include budget type details.
Includechildids Include child ticket IDs.
Includechildread Include child tickets that have been read.
Includechildren Filter on child tickets: 0 = no children/not a child, 1 = has children, 2 = is a child.
Includeclosed Filter on closed tickets: 1 = closed, 0 = not closed.
Includecolumns Include column details.
Includecompleted Include completed tickets.
Includecontract Include contract details.
Includecountryregion Include country/region details.
Includefirstname Include first name of user details.
Includefollowedonly Array of follower IDs to filter tickets.
Includehold Array of on-hold ticket IDs to filter.
Includeinactivetechs Array of inactive tech IDs to filter tickets.
Includeinactiveusers Filter on inactive users: 1 = inactive, 0 = active.
Includeitilname Include ITIL name details.
Includelastaction Include last action (only if one ticket returned).
Includelastincomingemail Include last incoming email details.
Includelastname Include last name of user details.
Includelastnote Include last note details.
Includelocked Include locked tickets.
Includemailbox Include email box details.
Includemailid Include mail ID.
Includemyuseronly Array of user IDs to filter tickets belonging to these users.
Includenextactivitydate Include next activity date.
Includenextappointmenttype Include next appointment type details.
Includeparentsubject Include parent ticket subject.
Includeprojects Filter projects: 1 = opportunities not projects, 2 = projects not opportunities, 0 = neither.
Includeread Array of read ticket IDs to filter.
Includerelatedservices Include related services.
Includerelease 1-3 Include release 1, 2, and 3 details respectively.
Includeservicecategory Include service category.
Includeslaactiondate Include SLA action date.
Includeslatimer Include SLA timer.
Includestatus Include status details.
Includesubmittedonly Array of agent submitted IDs to filter tickets.
Includesupplier Include supplier details.
Includetickettype Include ticket type details.
Includetimetaken Include time taken.
Includetoplevel Include top level details.
Includeviewing Include tickets currently being viewed.
Includeworkflowstage Include workflow stage details.
Includeworkflowstagenumber Include workflow stage number.
Includuserdepartments Include user departments.
Inlcludeopenchildcount Include count of open child tickets.
Invlucebranch Include branch details.
Ismilestone Filter on milestone status.
Isorion Include Orion integration details.
Isquicktimesearch Return only quick time tickets.
Isscom Include SCOM integration details.
Isteams Return only team tickets.
Iszapier Return a single ticket based on permissions.
Itil Requesttype Array of ITIL request type IDs to filter tickets.
Itil Requesttype Id Filter by specific ITIL ticket type.
Kanbanviewontheagentapp Include Kanban view on agent app.
Kanbanviewontheportal Include Kanban view on portal.
Lastupdatefromdate Filter tickets updated after this date.
Lastupdatetodate Filter tickets updated before this date.
List Id Filter by list ID.
Milestone Id Filter by milestone ID.
Mine Include only tickets belonging to the current user.
Nochargeonly Filter tickets with no charge only.
Notime Filter tickets with no time logged.
Onlytime Filter tickets with only time logged.
Open Only Return only open tickets.
Order, Order 2-5 Fields to order the results by (up to five levels).
Orderdesc, Orderdesc 2-5 Whether to order ascending or descending for each order field.
Orion Type Filter by Orion type.
Page No Pagination page number.
Page Size Pagination page size (max 100).
Pageinate Enable pagination.
Parent Id Filter by parent ticket ID.
Pending Review Filter tickets pending review.
Per Action Calculate billing per action.
Prepayorcontractonly Filter prepay or contract only tickets.
Priority Array of priority IDs to filter tickets.
Product Array of product IDs to filter tickets.
Project Ids Filter by project IDs.
Ready For Invoicing Filter tickets ready for invoicing.
Related Id Filter by related ticket ID.
Release Id Filter by release ID.
Requesttype Array of request type IDs to filter tickets.
Requesttype Id Filter by request type ID.
Requesttypegroup Array of request type group IDs to filter tickets.
Search General search string to filter tickets.
Search Details Search within ticket details.
Search Id Search by ticket IDs.
Search Inventory Number Search by asset tag.
Search Oppcompanyname Search by opportunity company name.
Search Oppcontactname Search by opportunity contact name.
Search Oppemailaddress Search by opportunity email address.
Search Release 1-3 Search by release 1, 2, or 3 fields.
Search Releasenote Search by release note.
Search Reportedby Search by reported by field.
Search Summary Search by summary field.
Search Supplier Reference Search by supplier reference.
Search User Name Search by user names.
Search Version Search by software version.
Searchactions Whether to search actions when using search.
Searchthisticketid Filter by specific ticket ID.
Service Id Filter by service ID.
Showonroadmap Filter roadmap visibility: 1 = visible, 0 = not visible.
Site Id Filter by site ID.
Sitepostcode Include site postcode details.
Sla Array of SLA IDs to filter tickets.
Sprint For Tickettype Id Filter sprint tickets by ticket type ID.
Sprints Return only sprint tickets.
Startandendset Filter tickets with project start and end dates set.
Startdate Start date for date range filters.
Startdatetime Include project start date and time details.
Status Array of status IDs to filter tickets.
Status Id Filter by specific status ID.
Submittedandagents Array of agent and agent submitted IDs to filter tickets.
Supplier Id Filter by supplier ID.
Supplier Status Array of supplier status IDs to filter tickets.
Team Array of team IDs to filter tickets.
Team Name Include team name details.
Ticketarea Id Filter tickets by ticket area ID.
Ticketcontract Id Filter by ticket contract ID.
Ticketidonly Return only ticket ID fields (not compatible with pagination).
Ticketids Return only specified tickets by IDs.
Ticketlinktype Filter by ticket link type.
Toplevel Id Filter by top-level ID.
Unlinked Only Return only unlinked tickets.
User Id Filter by user ID.
Username Filter by username.
Utcoffset Add offset to UTC date.
View Id Filter by filter profile ID.
Withattachments Return only tickets with one or more attachments.

Output

The node outputs an array of JSON objects representing the faults (tickets) retrieved from the Halo PSA API. Each object contains detailed information about a fault, including but not limited to:

  • Ticket identifiers and metadata.
  • Status, priority, categories, and types.
  • Assigned agents, teams, and followers.
  • Related assets, clients, contracts, and services.
  • Dates such as opened, closed, last updated, and SLA-related timestamps.
  • Additional optional details depending on the input properties selected (e.g., account manager, contract, SLA timers, notes, emails).

If binary data is involved (e.g., attachments), it would be handled separately, but this operation primarily returns JSON data about faults.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses HTTP requests to communicate with the Halo PSA REST API.
  • No other external dependencies beyond standard n8n helper functions and the included OpenAPI specification.

Troubleshooting

  • No credentials returned!: Ensure that the API credentials are correctly configured and available in n8n.
  • Resource or Operation not found: Verify that the resource is set to "Faults" and the operation to "List Of Faults".
  • Invalid parameter values: Many properties accept arrays or specific formats; ensure inputs conform to expected types (e.g., integers for IDs, booleans for flags).
  • Pagination issues: When using pagination, ensure page_no and page_size are set correctly and pageinate is enabled.
  • Large result sets: Use filters and pagination to avoid overwhelming responses.
  • API errors: If the API returns errors, check the error message in the output JSON and adjust parameters accordingly.
  • JSON parsing errors: Some parameters accept JSON strings; ensure they are valid JSON if entered manually.

Links and References

This summary is based on static analysis of the bundled source code and provided property definitions for the "Faults" resource and "List Of Faults" operation.

Discussion