HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions68

Overview

The "Client - Get Many" operation in this node retrieves multiple client records from the HaloPSA API. It is designed to fetch a list of clients with various filtering, sorting, and pagination options. This operation is useful for scenarios where you need to analyze, report on, or synchronize client data from HaloPSA into other systems or workflows.

Practical examples include:

  • Exporting all active clients for marketing campaigns.
  • Retrieving clients managed by a specific account manager.
  • Filtering clients based on integration types or custom fields.
  • Paginating through large client lists to process them in batches.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of results to return (used if Return All is false).
Filters Collection of filters to refine the client list:
  Account Manager Only Include only clients where you are an account manager.
  Active Inactive Two comma-separated values controlling inclusion of active and inactive clients.
  Advanced Search Advanced search string for complex queries.
  Azure Clients Include only Azure clients.
  Call Plan Include only clients with a call plan date in the past.
  Columns ID Column profile ID to filter by.
  Domain Filter clients by domain.
  Exclude Internal Exclude internal clients from results.
  GFI Clients Include only GFI clients.
  ID Only Return only the client ID field (not compatible with pagination).
  Include Active Include active clients in the response.
  Include Azure Tenants Include Azure tenant clients.
  Include Columns Include column details in the response.
  Include Custom Fields Include specified custom field IDs in the response.
  Include Inactive Include inactive clients in the response.
  Include Invoice Template Name Include invoice template names.
  Include Notes Include client notes.
  Include QBO Fields Include QuickBooks Online related fields.
  Integration Tenant IDs Comma-separated list of integration tenant IDs to filter by.
  Integration Type Filter by integration type.
  Is Jira Filter for Jira clients only.
  Is Sentinel Include only Sentinel clients.
  Is ServiceNow Filter for ServiceNow clients only.
  Last Update From Date Include last update from date field.
  Last Update To Date Include last update to date field.
  Order Field name to order results by first.
  Order 2-5 Additional fields to order results by second through fifth priority.
  Order Desc, Order Desc 2-5 Boolean flags to specify ascending/descending order for each ordering field.
  Page Number Page number to return when using pagination.
  Page Size Number of results per page when paginating (max 100).
  Paginate Whether to use pagination in the response.
  Search Filter clients by matching customers with this search string.
  Search Name Only Search clients by name only.
  Sentinel ID Filter by Sentinel ID.
  Show Counts Whether to show record counts.
  Site Fields IDs of site fields to include in the response.
  Snow Account ID Filter by ServiceNow account ID.
  Snow Clients Include only ServiceNow clients.
  Ticket Area ID Filter by ticket area ID.
  Top Level ID Filter clients belonging to a particular top-level customer.
  View ID Filter by view ID.

Output

The output JSON contains an array of client objects matching the applied filters and pagination settings. Each client object includes standard client fields such as IDs, names, domains, status flags, and optionally additional details depending on the selected properties (e.g., custom fields, notes, invoice template names, columns, QuickBooks Online fields).

If the "ID Only" option is enabled, the output will contain only client IDs instead of full client objects.

Binary data output is not applicable for this operation.

Dependencies

  • Requires a valid API key credential configured for the HaloPSA API.
  • The node depends on the HaloPSA REST API being accessible.
  • Pagination and filtering rely on the API's support for these features.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication errors.
    • Using incompatible options together (e.g., "ID Only" with pagination) may result in errors or unexpected behavior.
    • Providing invalid filter values or malformed search strings can lead to empty results or API errors.
    • Requesting too many records without enabling pagination might hit API limits or timeouts.

  • Error messages:

    • Authentication failures: Verify that the API key credential is correctly set up and has necessary permissions.
    • Validation errors on filters: Check that filter values conform to expected formats and types.
    • Rate limiting or timeout errors: Use pagination and limit the number of returned records to avoid overloading the API.

Links and References

Discussion