Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Site → List Of Site

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of sites based on various filtering and sorting criteria. It is useful for users who want to query site information from their Halo PSA system, such as active or inactive sites, sites filtered by client or contract, or sites with specific stock or address details.

Typical use cases include:

  • Fetching all active sites for reporting or synchronization.
  • Filtering sites by client or contract to manage resources.
  • Retrieving site addresses or notes for operational purposes.
  • Paginating through large sets of sites to process them in batches.

Properties

Name Meaning
Activeinactive Two comma-separated values controlling inclusion of active and inactive sites.
Advanced Search A string for advanced search filtering.
Azuresites Include only Azure sites in the response (boolean).
Client Id Filter sites by a specific client ID (integer).
Contract Id Filter sites by a specific contract ID (integer).
Count Number of results to return when not using pagination (integer).
Exclude Internal Exclude internal sites from the response (boolean).
Gfisites Include only GFI sites in the response (boolean).
Idonly Return only the Site ID field (not compatible with pagination) (boolean).
Includeactive Include active sites in the response (boolean).
Includeaddress Include site address details in the response (boolean).
Includeinactive Include inactive sites in the response (boolean).
Includenonstocklocations Include sites that are not stock locations (boolean).
Includenoorderstockbin Include sites without order stock bins (boolean).
Includenotes Include site notes in the response (boolean).
Includestocklocations Include sites that are stock locations (boolean).
Iscalendarfilter Include calendar filter field in the response (boolean).
Item Id Qty Include stock info fields for specified item id (boolean).
Item Salesorder Id Include stock info fields for specified sales order id (boolean).
Item Salesorder Line Include stock info fields for specified sales order line id (boolean).
Lastupdatefromdate Include last update from date field in the response (boolean).
Lastupdatetodate Include last update to date field 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).
Override Enablestockbins Overrides enabling of stock bins (boolean).
Page No Page number to return when using pagination (integer).
Page Size Size of the page when using pagination (integer).
Pageinate Whether to use pagination in the response (boolean).
Search Filter sites by customer name matching this string (string).
Site Id Filter by specific site ID (integer).
Sitefields Comma-separated IDs of site fields to include in the response (string).
Stocklocation Filter on stock locations, comma separated (string).
Toplevel Id Filter by specified top level ID (integer).
User Override User override flag (boolean).

Output

The node outputs an array of JSON objects representing the sites retrieved from the Halo PSA API according to the specified filters and options. Each object contains site data fields as returned by the API, which may include site IDs, names, addresses, notes, stock information, and other metadata depending on the input parameters.

If the idonly option is used, the output will contain only the site IDs.

No binary data output is produced by this operation.

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 additional external dependencies beyond the Halo PSA API and n8n's HTTP request helper.

Troubleshooting

  • No credentials returned!: This error occurs if the required API authentication credentials are missing or invalid. Ensure that the API key credential is properly configured in n8n.
  • Resource or Operation not found: If the specified resource or operation does not exist, verify that the correct resource ("Site") and operation ("List Of Site") are selected.
  • Invalid parameter values: Passing incorrect types or malformed strings (e.g., for comma-separated lists) may cause API errors. Validate inputs before execution.
  • Pagination conflicts: Using idonly together with pagination options is incompatible and may cause unexpected results.
  • API request failures: Network issues or API limits can cause request errors. Enable "Continue On Fail" to handle errors gracefully within workflows.

Links and References

Discussion