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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| publicationId | string | Sim | Id of the publication, such as pub_..., from List publications. |
| string | Não | Only the subscription of this exact email, in any letter case. | |
| status | string | Não | Only 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 |
| tier | string | Não | Only free or premium subscriptions. The default is all.Valores: free, premium, all |
| creation_date | string | Não | Only subscriptions created on this day, as YYYY/MM/DD. |
| order_by | string | Não | Sort field, the creation time.Valores: created |
| direction | string | Não | Sort direction. The default is asc.Valores: asc, desc |
| limit | integer | Não | Subscriptions per page, up to 100. The default is 10. |
| cursor | string | Não | Next 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
- Listar publicaçõesGETLista as publicações que a API key alcança, com id, name e organization_name. expand stats adiciona assinaturas ativas, taxas médias de abertura e clique e totais enviados. Pagine com page e limit, até 100; a resposta traz total_pages.
- Obter assinaturaGETRetorna uma assinatura com email, status, created, subscription_tier, os campos utm e referral_code.
- Criar assinaturaPOSTInscreve um email em uma publicação e retorna a assinatura com seu id. Com double opt-in na publicação, ou double_opt_override ativado, a pessoa confirma por email antes de ficar ativa.
- Atualizar assinaturaPATCHAtualiza uma assinatura. Só os campos enviados mudam. unsubscribe true cancela a inscrição da pessoa na publicação.
- Criar tag de assinaturaPOSTAdiciona tags a uma assinatura. Uma tag que ainda não existe na publicação é criada.
- Listar postsGETLista os posts de uma publicação com id, title, subtitle, status, publish_date e web_url. expand stats adiciona as estatísticas de email e web de cada post. Pagine com page e limit, até 100; a resposta traz total_pages.
- Obter postGETRetorna um post; expand stats adiciona suas estatísticas de email e web. Um post criado há pouco pode responder 202 enquanto o beehiiv o monta, e 404 com POST_CREATION_FAILED quando a criação falhou.
- Criar postPOSTCria um post a partir de HTML e retorna seu id; só nos planos Pro e Enterprise. status draft, o padrão, apenas salva; confirmed envia e publica na hora ou em scheduled_at. O beehiiv monta o post em segundo plano, então Get post pode responder 202 por um instante.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
