List Clients
halopsa.list_clients
ActionBusiness appsconnection required
Calls the HaloPSA API with the connection's credentials.
List the clients on the Halo instance.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- HaloPSA
- Secret shape
- {"client_id": "…", "client_secret": "…"} or {"client_id": "…", "refresh_token": "…"}
- Config it needs
- base_url, auth_url, tenant, scope
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
search Only return records matching this search string. | string | No | — | — | printer |
toplevel_id Only return clients belonging to this top level, by its numeric id. | string | No | — | — | 1 |
include_inactive Include inactive records in the response as well as active ones. | boolean | No | false | — | — |
order Name of the field to order the results by, as Halo names it. | string | No | — | — | id |
orderdesc Order the results descending rather than ascending. | boolean | No | false | — | — |
page_size How many records one page holds; Halo allows at most 100. Setting this or the page number turns pagination on. | number | No | — | 1–100 | — |
page_no Which page of results to return; the first page is 1. | number | No | — | ≥ 1 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"include_inactive": false,
"order": "id",
"orderdesc": false,
"search": "printer",
"toplevel_id": "1"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records Halo returned on this page. | array | — |
count How many records this response carried. | number | — |
record_count How many records match in total, as Halo reported; equal to count on a listing that is not paginated. | number | — |
{
"count": 0,
"items": [],
"record_count": 0
}See List Clients run in a workflow.
In a technical demo we add the HaloPSA connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.