Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Area → List Of Area

AI-generated

Overview

This node integrates with the Halo PSA API to list "Area" resources based on various filtering and pagination options. It is designed to retrieve detailed or summarized lists of areas (likely client or customer areas) from the Halo PSA system, supporting advanced search criteria, sorting, and selective field inclusion.

Common scenarios for this node include:

  • Fetching a filtered list of client areas managed by specific account managers.
  • Retrieving active or inactive areas for reporting or synchronization.
  • Paginating through large sets of area data.
  • Including additional related information such as notes, invoice template names, or integration details.
  • Filtering areas by integration types or other custom fields.

Practical examples:

  • A managed service provider could use this node to get all active client areas they manage for automated reporting.
  • An IT operations team might list only Azure or Sentinel clients' areas to focus on specific infrastructure.
  • A business analyst could pull paginated area data including invoice template names and notes for financial reconciliation.

Properties

Name Meaning
Accountmanageronly Include only clients that you are an account manager of in the response (boolean).
Activeinactive Takes two comma separated values: first sets includeactive, second sets includeinactive (string).
Advanced Search Advanced search query string for filtering areas.
Azureclients Include only Azure clients in the response (boolean).
Callplan Include only clients that have the field acalldate in the past (boolean).
Columns Id IDs of columns to include in the response.
Count Number of results to return when not using pagination (integer).
Domain Filter by domain (string).
Exclude Internal Exclude internal clients (boolean).
Gficlients Include only GFI clients in the response (boolean).
Idonly Return only the ID field (Area ID) of the clients; not compatible with pagination (boolean).
Includeactive Include clients that are active in the response (boolean).
Includeazuretenants Include Azure tenants in the response (boolean).
Includecolumns Include specified columns in the response (boolean).
Includeinactive Include clients that are inactive in the response (boolean).
Includeinvoicetemplatename Include invoice template names in the response (boolean).
Includenotes Include client notes in the response (boolean).
Includeqbofields Include QuickBooks Online fields in the response (boolean).
Integration Tenantids Filter by integration tenant IDs.
Integration Type Filter by integration type (string).
Isjira Filter by Jira integration presence (boolean).
Issentinel Include only Sentinel clients in the response (boolean).
Isservicenow Filter by ServiceNow integration presence (boolean).
Lastupdatefromdate Include the field lastupdatefromdate in the response (boolean).
Lastupdatetodate Include the field lastupdatetodate in the response (boolean).
Order The name of the field to order by first (string).
Order 2 The name of the field to order by second (string).
Order 3 The name of the field to order by third (string).
Order 4 The name of the field to order by fourth (string).
Order 5 The name of the field to order 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 When using pagination, the page number to return (integer).
Page Size When using pagination, the size of the page (integer).
Pageinate Whether to use pagination in the response (boolean).
Search Filter by customers matching your search string (string).
Search Name Only Filter by customers matching the search string only in their name (string).
Sentinelid Filter by sentinel ID (integer).
Showcounts Show counts in the response (boolean).
Sitefields IDs of site fields to include in the response (string).
Snowaccountid Filter by ServiceNow account ID (integer).
Snowclients Include only ServiceNow clients in the response (boolean).
Ticketarea Id Filter by ticket area ID (integer).
Toplevel Id Filter by customers belonging to a particular top level (integer).
View Id Filter by view ID (integer).

Output

The node outputs JSON data representing the list of areas retrieved from the Halo PSA API according to the specified filters and pagination settings. Each item in the output corresponds to one area record, containing fields as returned by the API, which may include IDs, names, status flags, notes, invoice template names, integration details, and other metadata depending on the input parameters.

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 these credentials to authenticate API requests.
  • Network access to the Halo PSA API endpoint is necessary.
  • No additional external dependencies beyond the n8n environment and the provided credentials.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API credentials. Ensure that the API key credential is properly configured in n8n and assigned to the node.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("Area") and operation ("List Of Area") are selected.

  • Invalid parameter values
    Some parameters expect specific formats (e.g., comma-separated strings for activeinactive). Providing invalid formats may cause API errors.

  • Pagination issues
    Using idonly together with pagination is incompatible and may cause unexpected results or errors.

  • API request failures
    Network issues, incorrect credentials, or API limits can cause request failures. Check connectivity and credential validity.

  • JSON parsing errors
    If using JSON parameters (like queryParameters or jsonRequestBody), ensure the JSON syntax is correct.

Links and References

Discussion