List Recipients
wise.list_recipients
ActionBusiness appsconnection required
Calls the Wise API with the connection's credentials.
List the recipient accounts a profile can pay, filtered by currency, account type or active state, one page at a time.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Wise
- Secret shape
- the Wise API token, or {"api_token": "…"}
- Config it needs
- base_url, api_version, profile_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
8 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 |
|---|---|---|---|---|---|
currency Keep only recipients in these currencies. Accepts a comma-separated list such as USD,GBP. | string | No | — | — | — |
account_type Keep only these account types. Accepts a comma-separated list such as iban,swift_code. | string | No | — | — | — |
active Keep only active recipients when true, deactivated ones when false. Wise defaults to true. | boolean | No | — | — | — |
owned_by_customer Keep only recipients the profile owner owns themselves. Leave unset to return every recipient. | boolean | No | — | — | — |
size How many recipients to return in this page. Wise's maximum, and its default, is 20. | number | No | — | 1–20 | — |
seek_position Start this page at the 'seek_position_for_next' returned by the previous call. | number | No | — | ≥ 0 | — |
sort Order the page by recipient id or currency. | string | No | — | one of "id,asc", "id,desc", "currency,asc", "currency,desc" | — |
profile_id Act for this Wise profile instead of the one on the connection. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records Wise returned for this request. | array | — |
count How many records are in 'items'. | number | — |
seek_position_for_next Pass this back as 'seek_position' to read the next page; absent on the last. | number | — |
seek_position_for_current Pass this back as 'seek_position' to re-read this same page. | number | — |
size The page size Wise actually applied. | number | — |
{
"count": 0,
"items": [],
"seek_position_for_current": 0,
"seek_position_for_next": 0,
"size": 0
}See List Recipients run in a workflow.
In a technical demo we add the Wise connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.