Listar assinaturas no beehiiv, por uma API

Lista as assinaturas (inscritos) de uma publicação, opcionalmente só de um email, status ou tier. Pagine com limit, até 100, e cursor: a resposta traz has_more e next_cursor.

Identificador
beehiiv_list_subscriptions

A chamada

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

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

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
publicationIdstringSimId of the publication, such as pub_..., from List publications.
emailstringNãoOnly the subscription of this exact email, in any letter case.
statusstringNãoOnly subscriptions in this status. pending waits for the double opt-in confirmation, inactive unsubscribed. The default is all.Valores: validating, invalid, pending, active, inactive, all
tierstringNãoOnly free or premium subscriptions. The default is all.Valores: free, premium, all
creation_datestringNãoOnly subscriptions created on this day, as YYYY/MM/DD.
order_bystringNãoSort field, the creation time.Valores: created
directionstringNãoSort direction. The default is asc.Valores: asc, desc
limitintegerNãoSubscriptions per page, up to 100. The default is 10.
cursorstringNãoNext page: the next_cursor of the previous response.

Conexões possíveis

O seu cliente conecta a conta do beehiiv 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/beehiiv_list_subscriptions. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do beehiiv

Ver as 12 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.