List Campaigns
getresponse.list_campaigns
ActionEmailconnection required
Calls the GetResponse API with the connection's credentials.
List the account's campaigns (contact lists), optionally filtered by name.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- GetResponse
- Secret shape
- the API key, or {"api_key": "…"}, or {"access_token": "…"} for OAuth2
- Config it needs
- region, domain, base_url
- 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 |
|---|---|---|---|---|---|
name Only return campaigns whose name matches this value. | string | No | — | — | — |
is_default Return only the account's default campaign, or only the others. Leave unset to return both. | boolean | No | — | — | — |
sort_field Property GetResponse orders the page by. | string | No | — | one of "name", "createdOn" | — |
sort_order Direction for 'sort_field'. GetResponse sorts ascending when this is left blank. | string | No | ASC | one of "ASC", "DESC" | — |
fields Comma-separated list of properties to return instead of the whole record. The id is always included. | string | No | — | — | contactId,email,name |
page Which page of results to fetch. GetResponse counts from 1. | number | No | 1 | ≥ 1 | 1 |
per_page How many records to ask GetResponse for in one page. | number | No | 100 | 1–1000 | 100 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"fields": "contactId,email,name",
"page": 1,
"per_page": 100,
"sort_order": "ASC"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records on this page, exactly as GetResponse returned them. | array | — |
returned How many records this page contains. | number | — |
page The page number that was requested. | number | — |
per_page The page size that was requested. | number | — |
has_more True when this page came back full, so another page probably follows. GetResponse reports the exact total only in a response header, which this node does not read. | boolean | — |
{
"has_more": false,
"items": [],
"page": 0,
"per_page": 0,
"returned": 0
}See List Campaigns run in a workflow.
In a technical demo we add the GetResponse connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.