Buscar contatos no GetResponse, por uma API

Busca os contatos de uma ou mais campanhas (listas de contatos) por status de inscrição e, opcionalmente, por email ou nome. Contatos de double opt-in não confirmados aparecem só aqui. Pagine com page e perPage, até 1000; uma página menor que perPage é a última.

Identificador
getresponse_search_contacts

A chamada

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

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
subscribersTypearraySimOne subscription status: subscribed, unconfirmed (double opt-in not confirmed yet), undelivered, or removed for the unsubscribed.
sectionLogicOperatorstringSimHow the sections combine: or matches any section, and matches all of them.Valores: or, and
sectionarraySimUp 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.
fieldsstringNãoFields to return, comma-separated, such as email,name,campaign. contactId always comes back.
perPageintegerNãoContacts per page, up to 1000. The default is 100.
pageintegerNãoPage number, starting at 1.

Conexões possíveis

O seu cliente conecta a conta do GetResponse uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/getresponse_search_contacts. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do GetResponse

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.