HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions68

Overview

This node integrates with the HaloPSA API to retrieve multiple "Site" records based on user-defined filters and pagination options. It is designed to fetch a list of sites, optionally including inactive ones, custom fields, and additional details. This node is useful in scenarios where you need to synchronize site data from HaloPSA into other systems, generate reports, or automate workflows that depend on site information.

For example, you could use this node to:

  • Retrieve all active sites for a specific client.
  • Fetch a paginated list of sites ordered by name or creation date.
  • Include custom field data for sites to enrich your dataset.
  • Search sites by keywords and filter results accordingly.

Properties

Name Meaning
Return All Whether to return all matching site records or limit the number of results.
Limit Maximum number of site records to return when not returning all. Minimum value is 1.
Filters Collection of filters to refine the site query:
- Client ID Filter sites belonging to a specific client by their numeric ID.
- Inactive Include inactive sites in the results if set to true.
- Include Custom Fields Select one or more custom field IDs to include in the response. These can be chosen from a dynamically loaded list or specified via expressions.
- Include Details Whether to include extra related objects/details in the response.
- Order The primary field name to order the results by.
- Order 2 Secondary field name to order by if primary fields are equal.
- Order 3 Third-level ordering field name.
- Order 4 Fourth-level ordering field name.
- Order 5 Fifth-level ordering field name.
- Order Desc Whether to order the primary field in descending order.
- Order Desc 2 Whether to order the second field in descending order.
- Order Desc 3 Whether to order the third field in descending order.
- Order Desc 4 Whether to order the fourth field in descending order.
- Order Desc 5 Whether to order the fifth field in descending order.
- Page Number When using pagination, specifies which page number of results to return (starting at 0).
- Page Size When using pagination, the number of results per page (maximum 100).
- Paginate Whether to paginate the response instead of returning all results at once.
- Search A search string to filter sites based on matching text.

Output

The node outputs an array of site objects in the json output field. Each object represents a site record retrieved from the HaloPSA API and includes standard site properties such as ID, name, status, and any requested custom fields or additional details if those options were enabled.

If custom fields or extra details are included, these will appear as nested properties within each site object.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the HaloPSA API.
  • The node depends on the HaloPSA API being accessible and properly configured.
  • No additional external services are required beyond the HaloPSA API.
  • Pagination and filtering rely on the API's support for these features.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Requesting too many records without pagination may lead to timeouts or rate limiting.
    • Using invalid field names in ordering or filters may result in errors or empty responses.
    • Specifying custom field IDs that do not exist or are not accessible may cause incomplete data.

  • Error Messages:

    • Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
    • Validation errors on input parameters suggest incorrect filter values or unsupported options; review property settings.
    • Rate limit errors require reducing request frequency or enabling pagination to limit data size.

Links and References

Discussion