Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Projects → List Of Faults

AI-generated

Overview

This node integrates with the Halo PSA API to list faults (tickets) related to projects. It allows users to retrieve detailed information about faults filtered by numerous criteria such as agent, client, status, priority, dates, and many other parameters. This is useful for IT service management, project tracking, and fault resolution workflows where you need to automate fetching and processing ticket data from Halo PSA.

Typical use cases include:

  • Automatically retrieving a filtered list of faults for reporting or dashboarding.
  • Integrating fault data into other systems or workflows for further automation.
  • Monitoring tickets based on specific agents, clients, or statuses.
  • Extracting fault details for invoicing or SLA compliance checks.

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 field in response, e.g., 'ninjarmm'.
Asset Id Integer to filter tickets by 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 upper bound date for calendar-based filtering of actions.
Calendar Startdate String specifying lower bound date for calendar-based filtering of actions.
Category 1-4 Arrays of category IDs (integers) to filter tickets by categories 1 through 4.
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 by multiple clients.
Client Ref String to filter tickets by client reference.
Closed Only Boolean to return only closed tickets.
Columns Id Integer specifying 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 number of tickets to return.
Datesearch String specifying which date field to filter on, e.g., 'dateoccured' (opened), 'datecleared' (closed).
Debug Boolean to enable debug mode.
Default Columns Boolean to include only default columns in response.
Deleted Boolean to filter deleted tickets.
Domain String to filter ticket areas: 'reqs' (requests), 'opps' (opportunities), 'prjs' (projects).
Enddate String for end date filter used with datesearch.
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 "allow all" ticket type 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 to filter approval tickets (1 = approval, 0 = not approval).
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 read status of child tickets.
Includechildren Array of integers to filter child tickets: 0 = no children/not a child, 1 = has children, 2 = is a child.
Includeclosed Array of integers to filter closed tickets: 1 = closed, 0 = not closed.
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 to filter inactive users: 1 = inactive, 0 = active.
Includeitilname Boolean to include ITIL name details.
Includelastaction Boolean to include last action (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 tickets.
Includemailbox Boolean to include mailbox details.
Includemailid Boolean to include mail ID.
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 to filter projects: 1 = opportunities not projects, 2 = projects not opportunities, 0 = neither.
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 String to filter tickets updated after this date.
Lastupdatetodate String 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 String to filter by project IDs.
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 search string.
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 release 1, 2, and 3 matching search.
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 to filter roadmap visibility: 1 = visible, 0 = not visible.
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 start and end project dates set.
Startdate String for start date filter used with datesearch.
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: Many properties are optional booleans, integers, strings, or arrays of integers used to filter or customize the returned fault/ticket data.)

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 item in the output corresponds to one fault record with detailed fields as returned by the API.

The exact structure depends on the API response and the included fields based on input parameters. It may contain nested objects for agents, clients, assets, statuses, SLAs, and other related entities depending on the inclusion flags.

No binary data output is indicated for this operation.

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.
  • No additional external dependencies beyond the standard n8n environment and the bundled openapi client.

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 "Projects" and operation to "List Of Faults".
  • Invalid parameter values: Some filters require specific types (e.g., integers or arrays of integers). Make sure inputs conform to expected types.
  • Pagination issues: When using pagination, ensure page_no, page_size, and pageinate are set correctly. Maximum page size is 100.
  • Ticketidonly incompatible with pagination: If ticketidonly is true, do not use pagination parameters.
  • API errors: Errors returned from the API will be passed through unless "Continue On Fail" is enabled, in which case error messages will appear in the output JSON under an error property.
  • Empty results: Adjust filters or remove overly restrictive parameters to get results.

Links and References

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

Discussion