HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions290

User → Get Many

AI-generated

Summary

Retrieve multiple User records from HaloPSA applying optional filters, pagination, and field selection.

Inputs

  • Return All — Boolean to decide whether to return all User records or limit the number returned.
  • Limit — Maximum number of User records to return when Return All is false.
  • Filters — A collection of filters to narrow down the Users returned, including status, roles, linked IDs, and various attributes.
  • Filters (JSON) — Dynamic JSON object for filters to override or specify filter criteria using expressions.

Output shape

a list of User records

The output array contains User objects adhering to the requested filters and fields. Pagination may apply unless Return All is set to true. If 'ID Only' filter is set, only User IDs are returned, but this disables pagination.

Examples

Example 1: Get the first 50 active Users belonging to a specific department.

Set Return All to false, Limit to 50, and in Filters set 'includeactive' to true and 'department_id' to the desired department ID.

Example 2: Return all Users that are approvers including their billing info.

Set Return All to true, and in Filters set 'allapprovers' to true and 'includebillinginfo' to true.

Links

Discussion