Actions68
- Client Actions
- Agent Actions
- Asset Actions
- Field Info Actions
- Invoice Actions
- Site Actions
- Ticket Actions
- Ticket Status Actions
- Ticket Type Actions
- Timesheet Actions
- Timesheet Event Actions
- Webhook Actions
- Webhook Event Actions
Overview
This node integrates with the HaloPSA API to retrieve multiple ticket records based on a wide range of filtering and sorting criteria. It is designed to fetch many tickets at once, supporting both full retrieval and paginated results. This functionality is useful for scenarios such as generating reports, syncing ticket data with other systems, or performing bulk analysis of tickets.
Practical examples include:
- Fetching all open tickets assigned to a specific agent.
- Retrieving tickets filtered by priority, status, or custom fields.
- Getting tickets created within a certain date range.
- Extracting tickets that have attachments or belong to particular clients or projects.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching tickets or limit the number of results. |
| Limit | Maximum number of tickets to return when not returning all. |
| Filters | A collection of detailed filter options to narrow down the tickets returned. These include: |
| - Advanced Search | Free text advanced search string. |
| - Agent / Agent ID | Filter tickets by agent IDs (single or comma-separated list). |
| - Alert Type | Include alert type details in response (e.g., "ninjarmm"). |
| - Asset ID | Filter by asset ID. |
| - Awaiting Input | Filter by awaiting input status. |
| - Billable Only | Return only billable tickets. |
| - Billing Contract ID | Filter by billing contract ID. |
| - Billing Date | Filter by billing date. |
| - Calendar Start/End Date | Filter actions before/after specified calendar dates. |
| - Categories 1 to 4 | Filter tickets by category IDs (comma-separated). |
| - CF Display Values Only | Use performant method to query custom fields (display values only). |
| - Check My Tickets Only | Return only tickets assigned to the current user. |
| - Client ID(s) | Filter by client ID or multiple client IDs (comma-separated). |
| - Client Ref | Filter by client reference string. |
| - Closed Only | Return only closed tickets. |
| - Columns ID | Specify column profile ID for response formatting. |
| - Contract ID / Period | Filter by contract ID or period. |
| - Date Search Field | Select which date field to filter by when using start/end dates (required). Options include audit date, creation date, deadline, SLA dates, etc. |
| - Debug | Enable debug mode for troubleshooting. |
| - Default Columns | Include only default columns in the response. |
| - Deleted | Include deleted tickets. |
| - Domain | Filter on ticket areas like requests, opportunities, projects. |
| - End Date | End date for date range filtering (used with Date Search Field). |
| - Exclude SLA Calcs | Exclude SLA calculation details from response. |
| - Exclude These | Exclude tickets with specified fault IDs (comma-separated). |
| - Extra Portal Filter | Additional portal filters like "MyTicketsOnly" or "MyClientTickets". |
| - Facebook ID | Filter by Facebook ID. |
| - Fetch Grand Children | Include grandchild tickets in response. |
| - Flagged | Filter by flagged ticket IDs (comma-separated). |
| - Followed and Agents | Filter by agent and follower IDs (comma-separated). |
| - Ignore Milestone Restriction | Ignore milestone restrictions in filtering. |
| - Include Account Manager | Include account manager details in response. |
| - Include Agent | Include agent details in response. |
| - Include All Open | Include all open tickets regardless of other filters. |
| - Include Appointment ID | Include appointment ID in response. |
| - Include Approval | Filter on approval tickets (1 = approval, 0 = not approval). |
| - Include Asset Key Field | Include asset key field in response. |
| - Include Asset Type | Include asset type details in response. |
| - Include Branch | Include branch information in response. |
| - Include Breached | Filter by breached ticket IDs (comma-separated). |
| - Include Budget Type | Include budget type details in response. |
| - Include Child IDs | Include child ticket IDs in response. |
| - Include Child Read | Include details of child tickets that have been read. |
| - Include Children | Filter on child tickets (no children, has children, is child). |
| - Include Closed | Filter on closed tickets (closed or not closed). |
| - Include Columns | Include column details in response. |
| - Include Completed | Include completed tickets. |
| - Include Contract | Include contract details in response. |
| - Include Country Region | Include country/region details in response. |
| - Include Custom Fields | Select custom field IDs to include in response. |
| - Include First Name | Include first name of user details. |
| - Include Followed Only | Filter by follower IDs (comma-separated). |
| - Include Hold | Filter by on-hold ticket IDs (comma-separated). |
| - Include Inactive Techs | Filter by inactive technician IDs (comma-separated). |
| - Include Inactive Users | Filter on inactive users (inactive or active). |
| - Include ITIL Name | Include ITIL name details. |
| - Include Last Action | Include last action details (only for single ticket). |
| - Include Last Incoming Email | Include last incoming email details. |
| - Include Last Name | Include last name of user details. |
| - Include Last Note | Include last note details. |
| - Include Locked | Include locked tickets. |
| - Include Mail ID | Include mail ID in response. |
| - Include Mailbox | Include mailbox details. |
| - Include My User Only | Filter by current user ID (comma-separated). |
| - Include Next Activity Date | Include next activity date. |
| - Include Next Appointment Type | Include next appointment type details. |
| - Include Open Child Count | Include count of open child tickets. |
| - Include Parent Subject | Include parent subject in response. |
| - Include Projects | Filter on projects or opportunities. |
| - Include Read | Filter by read ticket IDs (comma-separated). |
| - Include Related Services | Include related services in response. |
| - Include Release 1,2,3 | Include release details 1, 2, and 3 respectively. |
| - Include Service Category | Include service category details. |
| - Include SLA Action Date | Include SLA action date. |
| - Include SLA Timer | Include SLA timer details. |
| - Include Status | Include status details. |
| - Include Submitted Only | Filter by agent submitted IDs (comma-separated). |
| - Include Supplier | Include supplier details. |
| - Include Ticket Type | Include ticket type details. |
| - Include Time Taken | Include time taken details. |
| - Include Top Level | Include top level details. |
| - Include User Departments | Include user department details. |
| - Include Viewing | Include tickets currently being viewed. |
| - Include Workflow Stage | Include workflow stage details. |
| - Include Workflow Stage Number | Include workflow stage number. |
| - Is Milestone | Filter by milestone tickets. |
| - Is Orion | Include integration Orion details. |
| - Is Quick Time Search | Return only quick time tickets. |
| - Is SCOM | Include integration SCOM details. |
| - Is Teams | Return only team tickets. |
| - Is Zapier | Return a single ticket based on permissions. |
| - ITIL Request Type / ID | Filter by ITIL request type IDs. |
| - Kanban View On Agent App | Include kanban view for agent app. |
| - Kanban View On Portal | Include kanban view for portal. |
| - Last Update From/To Date | Filter tickets updated within date range. |
| - List ID | Filter by list ID. |
| - Milestone ID | Filter by milestone ID. |
| - Mine | Include only tickets belonging to the current user. |
| - No Charge Only | Return only no-charge tickets. |
| - No Time | Exclude time information. |
| - Only Time | Return only time information. |
| - Open Only | Return only open tickets. |
| - Order / Order Desc | Specify up to five fields to order by and whether each is ascending or descending. |
| - Orion Type | Filter by Orion type. |
| - Page Number / Size | Pagination controls: page number and size (max 100). |
| - Paginate | Whether to use pagination. |
| - Parent ID | Filter by parent ticket ID. |
| - Pending Review | Filter on pending review status. |
| - Per Action | Calculate billing per action. |
| - Prepay or Contract Only | Return only prepaid or contract tickets. |
| - Priority | Filter by priority IDs (comma-separated). |
| - Product | Filter by product IDs (comma-separated). |
| - Project IDs | Filter by project IDs (comma-separated). |
| - Ready for Invoicing | Filter on ready for invoicing status. |
| - Related ID | Filter by related ticket ID. |
| - Release ID | Filter by release ID. |
| - Request Type Group | Filter by request type group IDs (comma-separated). |
| - Request Type ID / Names | Filter by request type IDs or names. |
| - Search | General search string to filter tickets. |
| - Search Actions | Whether to search ticket actions when using search. |
| - Search Details | Filter tickets by matching details. |
| - Search ID | Filter tickets by matching IDs. |
| - Search Inventory Number | Filter tickets by asset tag. |
| - Search Opp Company/Contact/Email | Filter tickets by opportunity company name, contact name, or email address. |
| - Search Release 1,2,3 | Filter tickets by release notes or versions. |
| - Search Reported By | Filter tickets by reported by field. |
| - Search Summary | Filter tickets by summary text. |
| - Search Supplier Reference | Filter tickets by supplier reference. |
| - Search This Ticket ID | Filter by a specific ticket ID. |
| - Search User Name | Filter tickets by user name. |
| - Search Version | Filter tickets by software version. |
| - Service ID | Filter by service ID. |
| - Show on Roadmap | Filter by roadmap visibility. |
| - Site ID | Filter by site ID. |
| - Site Postcode | Include site postcode details. |
| - SLA | Filter by SLA IDs (comma-separated). |
| - Sprint for Ticket Type ID | Filter by sprint for specific ticket type. |
| - Sprints | Return only sprint tickets. |
| - Start and End Set | Filter tickets with project start and end dates set. |
| - Start Date / End Date | Date range filters used with Date Search Field. |
| - Start Date Time / End Date Time | Include project start/end date and time details. |
| - Status ID / Names | Filter by status IDs or names. |
| - Submitted and Agents | Filter by agent and agent submitted IDs (comma-separated). |
| - Supplier ID / Status | Filter by supplier ID or supplier status IDs. |
| - Team / Team Name | Filter by team IDs or include team name details. |
| - Third Party ID / String | Filter by third party ID or string. |
| - Ticket Area ID | Filter by ticket area ID. |
| - Ticket Contract ID | Filter by ticket contract ID. |
| - Ticket ID Only | Return only ticket ID fields (not compatible with pagination). |
| - Ticket IDs | Return only specified tickets by IDs (comma-separated). |
| - Ticket Link Type | Filter by ticket link type. |
| - Top Level ID | Filter by top level ID. |
| - Unlinked Only | Return only unlinked tickets. |
| - User ID / Username | Filter by user ID or username. |
| - UTC Offset | Add offset to UTC date for date filters. |
| - View ID | Filter by filter profile ID. |
| - With Attachments | Return only tickets with one or more attachments. |
Output
The node outputs an array of ticket objects in the json output field. Each object represents a ticket with fields corresponding to the requested properties and filters. The exact structure depends on the included fields and filters but typically includes ticket metadata such as IDs, statuses, agents, dates, priorities, custom fields, and related entities.
If binary data is supported (not explicitly shown here), it would represent attachments or related files associated with tickets.
Dependencies
- Requires connection to the HaloPSA API.
- Requires an API authentication credential configured in n8n (an API key or token).
- The node uses internal methods to load options dynamically for ticket types, statuses, and custom fields via API calls.
- No additional external dependencies are indicated.
Troubleshooting
Common Issues:
- Incorrect or missing API credentials will cause authentication failures.
- Using incompatible filter combinations (e.g.,
ticketidonlywith pagination) may result in errors or unexpected behavior. - Providing invalid date ranges without selecting a date field (
datesearch) can cause the API to reject the request. - Large result sets without enabling pagination or limiting results may lead to timeouts or performance issues.
Error Messages:
- Authentication errors: Verify API credentials and permissions.
- Validation errors: Check that required parameters like
datesearchare set when using date filters. - Rate limiting or timeout errors: Consider enabling pagination or reducing the number of results requested.
Links and References
- HaloPSA API Documentation (general reference)
- n8n Expressions Documentation (for dynamic property values)
- HaloPSA Custom Fields Guide (for understanding custom field usage)
This summary is based solely on static analysis of the provided source code and property definitions.