Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Serv Site → List Of Serv Site

AI-generated

Overview

This node integrates with the Halo PSA API to list service sites ("Serv Site"). It allows users to query and retrieve a filtered, paginated list of service sites based on various criteria such as access control level, asset IDs, service categories, ticket types, and more. This is useful in scenarios where you want to automate fetching service site data for reporting, monitoring, or further processing within an n8n workflow.

For example, you could use this node to:

  • Retrieve all monitored service sites related to a specific asset.
  • List service sites filtered by certain service categories or statuses.
  • Paginate through large sets of service sites for batch processing.

Properties

Name Meaning
Access Control Level Filter service sites by their access control level.
Asset Ids Comma-separated string of asset IDs to filter service sites associated with these assets.
Count Limit the number of results returned.
Includechildservices Whether to include child services in the response.
Includestatusinfo Whether to include status information for each service site.
Itil Ticket Type Filter service sites by ITIL ticket type.
Monitoredonly Filter to only monitored service sites.
Order Primary field to order the results by.
Order 2 Secondary ordering field.
Order 3 Tertiary ordering field.
Order 4 Fourth-level ordering field.
Order 5 Fifth-level ordering field.
Orderdesc Boolean flag to indicate descending order for primary order field.
Orderdesc 2 Descending order flag for secondary order field.
Orderdesc 3 Descending order flag for tertiary order field.
Orderdesc 4 Descending order flag for fourth order field.
Orderdesc 5 Descending order flag for fifth order field.
Page No Page number for paginated results.
Page Size Number of items per page.
Pageinate Flag to enable or disable pagination.
Parent Service Category Id Filter by parent service category ID.
Relatedservicesonly Filter to only related services.
Search Text search filter for service sites.
Service Category Id Filter by a single service category ID.
Service Category Ids Comma-separated string of multiple service category IDs.
Service Status Ids Comma-separated string of service status IDs to filter by.
Subscribedonly Filter to only subscribed service sites.
Template Id Filter by template ID.
Ticket Id Filter by ticket ID.
Tickettype Id Filter by ticket type ID.
User Id Filter by user ID.

Output

The node outputs an array of JSON objects representing the service sites retrieved from the Halo PSA API. Each item corresponds to one service site and contains all the fields returned by the API for that service site, including any requested additional information such as status info or child services.

If the operation involves binary data (not applicable here), it would be included in the binary property of the output item, but this operation only returns JSON 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 beyond the standard n8n environment and the provided credentials.

Troubleshooting

  • No credentials returned!: This error occurs if the node cannot find or access the required API authentication credentials. 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 ("Serv Site") and operation ("List Of Serv Site") are selected.
  • API request errors: Network issues, invalid parameters, or permission problems may cause API request failures. Check the error message returned in the output JSON for details.
  • JSON parsing errors: If using JSON parameters, ensure that JSON strings are well-formed and valid.
  • Pagination parameters must be consistent; incorrect page numbers or sizes might result in empty responses.

Links and References

Discussion