Search contacts with the GetResponse API

Searches the contacts of one or more campaigns (contact lists) by subscription status and, optionally, by email or name. Unconfirmed double opt-in contacts show up only here. Page with page and perPage, up to 1000; a page shorter than perPage is the last.

Identifier
getresponse_search_contacts

The request

POST https://connect.reportei.com/api/tools/getresponse_search_contacts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "subscribersType": [],
    "sectionLogicOperator": "or",
    "section": []
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
subscribersTypearrayYesOne subscription status: subscribed, unconfirmed (double opt-in not confirmed yet), undelivered, or removed for the unsubscribed.
sectionLogicOperatorstringYesHow the sections combine: or matches any section, and matches all of them.Values: or, and
sectionarrayYesUp to 8 groups of criteria. In each, campaignIdsList has the campaignId values from List campaigns; subscriberCycle with both values ignores the autoresponder cycle; subscriptionDate all_time ignores the date, and custom needs customDate. conditions is optional: up to 8 conditions on email or name, with operatorType string_operator, such as conditionType email, operator is and the address as value.
fieldsstringNoFields to return, comma-separated, such as email,name,campaign. contactId always comes back.
perPageintegerNoContacts per page, up to 1000. The default is 100.
pageintegerNoPage number, starting at 1.

Supported connections

Your customer connects their GetResponse account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/getresponse_search_contacts. It becomes your agent's tool definition with no conversion.

Other GetResponse tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.