Listar inscritos no Kit, por uma API

Lista os inscritos com id, e-mail, nome, estado e campos personalizados, apenas os ativos por padrão. Busque um por email_address. A resposta traz subscribers e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.

Identificador
kit_list_subscribers

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "email_address": "<email_address>"
  }
}

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
email_addressstringNãoOnly the subscriber with exactly this email address. Does not work together with an engagement sort_field.
statusstringNãoOnly the subscribers in this state. The default is active, and all returns every state.Valores: active, inactive, bounced, complained, cancelled, all
created_afterstringNãoOnly the subscribers created after this date, as YYYY-MM-DD.
created_beforestringNãoOnly the subscribers created before this date, as YYYY-MM-DD.
updated_afterstringNãoOnly the subscribers updated after this date, as YYYY-MM-DD.
updated_beforestringNãoOnly the subscribers updated before this date, as YYYY-MM-DD.
sort_fieldstringNãoField to sort by. The default is id. The engagement fields count the last 90 days, and cancelled_at needs status cancelled.Valores: id, created_at, updated_at, cancelled_at, engagement__sent, engagement__opens, engagement__clicks, engagement__open_rate, engagement__click_rate
sort_orderstringNãoOrder of the sort.Valores: asc, desc
includestringNãoExtra fields on each subscriber, separated by commas: attribution, tags, location, and canceled_at, which needs status cancelled.
per_pageintegerNãoSubscribers per page, up to 1000. The default is 500.
afterstringNãoThe pagination.end_cursor of the previous page.

Conexões possíveis

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

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/kit, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

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/kit_list_subscribers. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Kit

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.