Search Contacts
getresponse.search_contacts
ActionEmailconnection required
Calls the GetResponse API with the connection's credentials.
Run GetResponse's segment-builder search, the only query that also reaches contacts awaiting double opt-in confirmation.
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
8 fields, 1 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 |
|---|---|---|---|---|---|
section GetResponse's condition sections, passed through as sent. Each section carries its own 'logicOperator' and 'conditions' list. | array | Yes | — | array of object | [{"campaignIdsList":["V3J"],"logicOperator":"or","subscriberCycle":["receiving_autoresponder"],"subscriptionDate":"all_time"}] |
logic_operator Whether a contact must match any section ('or') or every section ('and'). | string | No | or | one of "or", "and" | — |
subscribers_type Which subscription states to include, comma-separated. GetResponse requires this, so leaving it blank searches 'subscribed' contacts. Allowed values: subscribed, undelivered, removed, unconfirmed. | string | No | subscribed | — | subscribed |
sort_field Property GetResponse orders the page by. | string | No | — | one of "email", "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",
"logic_operator": "or",
"page": 1,
"per_page": 100,
"section": [
{
"campaignIdsList": [
"V3J"
],
"logicOperator": "or",
"subscriberCycle": [
"receiving_autoresponder"
],
"subscriptionDate": "all_time"
}
],
"sort_order": "ASC",
"subscribers_type": "subscribed"
}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 Search Contacts 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.