Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Opps → List Of Faults

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of faults (tickets) related to opportunities ("Opps" resource). It allows users to perform detailed and highly customizable queries to fetch fault records based on numerous filtering criteria such as agent, client, asset, status, priority, dates, and many other parameters.

Typical use cases include:

  • Extracting fault tickets for reporting or analysis.
  • Automating workflows that depend on ticket data from the Halo PSA system.
  • Filtering faults by specific agents, clients, or categories to monitor performance or workload.
  • Integrating fault data into dashboards or other systems for real-time updates.

For example, a user might want to list all open faults assigned to a particular agent within a date range or retrieve faults flagged as high priority for billing purposes.

Properties

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

(Note: The above table summarizes the extensive list of input properties available for filtering and customizing the "List Of Faults" operation under the "Opps" resource.)

Output

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

  • Ticket identifiers and metadata.
  • Status, priority, and category details.
  • Associated agents, clients, assets, and contracts.
  • Dates related to creation, updates, and billing.
  • Flags and flags-related information.
  • SLA and workflow stage details.
  • Optional inclusion of related entities like account managers, suppliers, appointments, and more depending on input parameters.

If binary data is involved (not typical for this operation), it would be included accordingly, but this operation primarily returns JSON data.

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 API endpoints.
  • Proper configuration of the API credentials in n8n is necessary.
  • The node depends on the n8n-workflow package for error handling and helpers.
  • Uses lodash for utility functions and a custom OpenAPI parser for property definitions.

Troubleshooting

  • No credentials returned!: Ensure that the API credentials are correctly configured and accessible in n8n.
  • Resource or Operation not found: Verify that the selected resource is "Opps" and operation is "List Of Faults".
  • Invalid parameter values: Many parameters expect specific types (int, bool, string, arrays). Providing incorrect types may cause errors.
  • Pagination issues: When using pagination, ensure page_no, page_size, and pageinate are set correctly; ticketidonly is incompatible with pagination.
  • API errors: Network issues, invalid credentials, or API limits can cause errors. Enable debug mode (debug property) to get more insight.
  • JSON parsing errors: If using JSON parameters, ensure they are well-formed JSON strings.

Links and References

This summary provides a comprehensive overview of the "List Of Faults" operation for the "Opps" resource in the Halo PSA node, detailing its capabilities, inputs, outputs, dependencies, and common troubleshooting tips.

Discussion