List Contacts
xero.list_contacts
ActionCRM & salesconnection required
Calls the Xero API with the connection's credentials.
List the organisation's customers and suppliers, with filtering and paging.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Xero
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}
- Config it needs
- tenant_id
- 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 |
|---|---|---|---|---|---|
where Xero filter expression, e.g. Status=="AUTHORISED" AND Type=="ACCREC". | string | No | — | — | — |
order Xero sort expression, e.g. UpdatedDateUTC DESC. | string | No | — | — | — |
search_term Case-insensitive free-text search across the contact's name and contact-detail fields. | string | No | — | — | — |
include_archived Include contacts whose status is ARCHIVED. | boolean | No | false | — | — |
page Page of results to fetch; Xero returns up to 100 records per page by default. | number | No | — | ≥ 1 | — |
page_size Records per page, from 1 to 1000 (Xero's maximum). | number | No | — | 1–1000 | — |
tenant_id Xero organisation (tenant) id for this call; overrides the connection's. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"include_archived": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records Xero returned for this page. | array | — |
count How many records are in 'items'. | number | — |
{
"count": 0,
"items": []
}See List Contacts run in a workflow.
In a technical demo we add the Xero connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.