Get Lists
sendy.get_lists
ActionEmailconnection required
Calls the Sendy API with the connection's credentials.
List every list under one brand, which is where the list ids the other nodes need come from.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Sendy
- Secret shape
- the Sendy API key, or {"api_key": "…"}
- Config it needs
- base_url, list_id, brand_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 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 |
|---|---|---|---|---|---|
brand_id The Sendy brand to act on; overrides the brand set on the connection. | string | No | — | — | 1 |
include_hidden Include lists marked hidden in the Sendy UI. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"brand_id": "1",
"include_hidden": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
lists One row per list, each with its id and name. | array | — |
count How many lists were returned. | number | — |
brand_id The brand the lists belong to. | string | — |
{
"brand_id": "",
"count": 0,
"lists": []
}See Get Lists run in a workflow.
In a technical demo we add the Sendy connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.