HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions290

Client → Get Many

AI-generated

Summary

Retrieve multiple client records from HaloPSA with optional filters, pagination, and selective field inclusion.

Inputs

  • returnAll — Boolean to specify whether to return all matching clients or limit the number of results.
  • limit — Maximum number of client records to return if not returning all.
  • filters — Collection of filters to refine the client list, including account manager only, active/inactive status, custom searches, client types, and ordering options.
  • filtersJson — Advanced dynamic filters as a JSON object where values override those in the Filters collection, supporting expressions.

Output shape

a list of client records

The response returns an array of client objects, each containing standard and optionally selected custom fields, columns, notes, and related metadata depending on filters applied. Pagination is supported via page number and size when enabled. Using 'ID Only' filter returns only client IDs without pagination support.

Links

Discussion