Query Halo Users
The Query Halo Users action finds users and contacts in Halo PSA. It can return the first match or an array containing up to 100 matches.
This action searches only the first result page and applies every configured filter in Halo.
When to Use This Action
Use this action when you need to:
- Find a user by name or email address
- Find users belonging to a client or site
- Include active users, inactive users, or both
- Filter users with Halo Custom Fields
- Retrieve all readable User Custom Fields
Do not use this action to retrieve more than 100 users. Narrow the filters or use Halo's API directly when you need later pages.
How It Works
The action first checks which User Custom Fields your Halo connection can read. It then asks Halo for page 1 with all of those fields included.
The default order is User ID from lowest to highest. In First match mode, a non-Continue multiple-results choice makes the action request two users so it can check uniqueness.
The action counts users returned on page 1 rather than Halo's reported total. It stores a successful result before applying a result-count choice. A request error or malformed response uses Error Handling, clears the result to null, and does not trigger a no-results choice.
Configuration
Results
| Field | Description | Default |
|---|---|---|
| Results | Return Up to 100 matches as an array, or First match as one object or null. | Up to 100 matches |
| Order By | Sort by User ID or Name. | User ID |
| Order Descending | Reverse the selected order. | Disabled |
Filters
| Field | Description |
|---|---|
| Search | Search users by name or email address. |
| Client | Return users belonging to the selected client. This also narrows the Site list. |
| Site | Return users belonging to the selected site. |
| Active State | Return active users, inactive users, or both. |
| Custom Field Filters | Build grouped AND/OR conditions using Halo User Custom Fields. |
Error Handling
| Field | Description |
|---|---|
| Error Handling | Choose what happens when either Halo request fails or returns malformed data. Available choices depend on the type of automation. |
| If no results are returned | Choose what happens after a successful query returns no users. |
| If more than one result is returned | Choose what happens after a successful query returns multiple users. A non-Continue choice enables a two-user uniqueness check in First match mode. |
Returned Variables
In First match mode, the stored result is one user object or null. In Up to 100 matches mode, the result is an array capped at 100 users, including [] when no user matches.
Common properties include .id, .name, .emailaddress, .client_id, .client_name, .site_id, .site_name, .inactive, .phonenumber, .mobilenumber, .jobtitle, .notes, and .customfields.
For the first result in array mode, use a value such as {{custom.users.[0].id}}.