Buscar contactos en GetResponse, con una API

Busca los contactos de una o más campañas (listas de contactos) por estado de suscripción y, opcionalmente, por email o nombre. Los contactos de double opt-in sin confirmar aparecen solo aquí. Pagina con page y perPage, hasta 1000; una página menor que perPage es la última.

Identificador
getresponse_search_contacts

La llamada

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": []
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
subscribersTypearraySíOne subscription status: subscribed, unconfirmed (double opt-in not confirmed yet), undelivered, or removed for the unsubscribed.
sectionLogicOperatorstringSíHow the sections combine: or matches any section, and matches all of them.Valores: or, and
sectionarraySíUp 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.

Conexiones posibles

Tu cliente conecta su cuenta de GetResponse una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/getresponse_search_contacts. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de GetResponse

Ver las 13 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.