Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Device → List Of Device

AI-generated

Overview

This node integrates with the Halo PSA API to list devices (assets) managed within the Halo PSA system. It allows users to retrieve a filtered and paginated list of devices based on numerous criteria such as asset groups, types, statuses, clients, sites, contracts, and more. This is useful for IT service management, asset tracking, and inventory automation workflows where you need to query and process device information from Halo PSA.

Practical examples include:

  • Fetching all active devices belonging to a specific client or site.
  • Retrieving devices filtered by asset type or status for reporting.
  • Listing devices linked to particular contracts or tickets.
  • Paginating through large sets of assets for batch processing or synchronization.

Properties

Name Meaning
Activeinactive Filter on active/inactive assets - comma separated, first value true/false for active, second for inactive.
Advanced Search Advanced search string filter.
Assetgroup Id Filter by assets belonging to a particular asset group (integer).
Assetgroups Filter assets on asset groups, comma separated IDs.
Assets Filter assets by asset identifiers (string).
Assetstatuses Filter assets on asset statuses, comma separated IDs.
Assettype Filter by asset type (generic).
Assettype Id Filter by assets belonging to a particular asset type (integer).
Assettypes Filter assets on asset types, comma separated IDs.
Bookmarked Include only bookmarked assets (boolean).
Client Id Filter by assets belonging to a particular client (integer).
Columns Id The column profile ID (integer).
Consignable Include only consignable assets (boolean).
Consignment Id Filter by assets consignment ID (integer).
Contract Id Filter by assets assigned to a particular contract (integer).
Contract Id Adding To Include billing period of linked contract ID in response (integer).
Count Number of assets to return in the response (integer).
Domotzagents Include only assets with a linked Domotz agent (boolean).
Excludethese Exclude assets by these asset IDs, comma separated.
Global Search ID Global search identifier (string).
Idonly Include only the asset ID in the response (boolean).
Includeactive Include active assets in the response (boolean).
Includeallowedstatus Include the asset column 'tallowallstatus' in the response (boolean).
Includeassetfields Include asset fields in the response; requires specifying 'assettype_id' (boolean).
Includechildren Include child assets in the response (boolean).
Includecolumns Include column details in the response (boolean).
Includeinactive Include inactive assets in the response (boolean).
Includeservices Include linked service IDs in the response (boolean).
Includeuser Include user details in the response (boolean).
Integration Tenantids Filter by integration tenant IDs (generic).
Integration Type Filter on integration source: e.g., 'aterarmm', 'ninjarmm', 'syncromsp', 'domotz', 'connectwiseautomate', 'snow', 'datto', 'passportal', 'addigy', 'liongard'.
Inventory Number Filter by inventory number (string).
Islogonbehalfview Unknown boolean flag related to logon behalf view.
Item Id Filter by asset item ID (integer).
Itemstock Id Filter by asset item stock ID (integer).
Kb Id Knowledge base ID filter (integer).
Lastupdatefromdate Include field lastupdatefromdate in response (boolean).
Lastupdatetodate Include field lastupdatetodate in response (boolean).
Licence Id Filter by assets assigned to a particular license (integer).
Linked To Ticket Filter assets linked to a ticket (generic).
Linkedto Id Filter by assets linked to a particular asset (integer).
Mine Include only assets that belong to yourself (boolean).
Mysite Include only assets that belong to your site (boolean).
Noicon Exclude the asset icon in the response (boolean).
Order Field name to order results by first (string).
Order 2 Field name to order results by second (string).
Order 3 Field name to order results by third (string).
Order 4 Field name to order results by fourth (string).
Order 5 Field name to order results by fifth (string).
Orderdesc Whether to order ascending or descending on first order (boolean).
Orderdesc 2 Whether to order ascending or descending on second order (boolean).
Orderdesc 3 Whether to order ascending or descending on third order (boolean).
Orderdesc 4 Whether to order ascending or descending on fourth order (boolean).
Orderdesc 5 Whether to order ascending or descending on fifth order (boolean).
Page No Pagination page number to return (integer).
Page Size Pagination page size (integer).
Pageinate Whether to use pagination in the response (boolean).
Previously Selected Include most recent dateoccurred field from linked ticket (boolean).
Previously Selected Client Id Filter previously selected by client ID (integer).
Previously Selected Site Id Filter previously selected by site ID (integer).
Previously Selected User Id Filter previously selected by user ID (integer).
Salesorder Id Filter by assets sales order ID (integer).
Salesorder Line Filter by assets sales order line ID (integer).
Search Filters response based on search string (string).
Search Inventory Number Only Whether to search only on inventory number in the search string (boolean).
Service Id Filter by assets belonging to a particular service (integer).
Service Ids Filter assets on service IDs, comma separated (string).
Site Id Filter by assets belonging to a particular site (integer).
Stockbin Id Filter by stock bin ID (integer).
Stockbin Ids Filter by stock bin IDs (comma separated).
Supplier Contract Id Filter by assets assigned to a particular supplier contract (integer).
Supplier Id Filter by assets belonging to a particular supplier (integer).
Suppliercontracts Filter assets on supplier contracts, comma separated IDs (string).
Ticket Id Filter by assets belonging to a particular ticket (integer).
Tickettype Id Filter by ticket type ID (integer).
User Id Filter by user ID (integer).
Username Filter by username (string).

Output

The node outputs an array of JSON objects representing the devices (assets) retrieved from the Halo PSA API according to the specified filters. Each object contains detailed information about a device, including its properties, status, linked entities, and optionally additional fields depending on the input parameters.

If binary data were involved (e.g., attachments), it would be included in the output, but this operation ("List Of Device") does not handle binary data.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses the base URL, tenant identifier, client ID, and client secret from the credentials to authenticate requests.
  • No other external dependencies are required.
  • Proper configuration of the Halo PSA API credentials in n8n is necessary.

Troubleshooting

  • No credentials returned!: Ensure that the API key credential for Halo PSA is properly configured and connected.
  • Resource or Operation not found: Verify that the resource is set to "Device" and operation to "List Of Device".
  • Invalid filter values: Some filters expect integers or booleans; providing incorrect types may cause errors.
  • API request failures: Network issues or invalid credentials can cause request failures. Check connectivity and credential validity.
  • Pagination issues: If using pagination, ensure page_no and page_size are set correctly.
  • JSON parsing errors: When using advanced JSON parameters, ensure valid JSON syntax.

Links and References

  • Halo PSA API Documentation (general reference for API endpoints)
  • n8n documentation on HTTP Request Node for understanding how API calls are made
  • n8n community forums for troubleshooting custom nodes and integrations

Discussion