Lister les abonnements avec l'API beehiiv

Liste les abonnements (abonnés) d'une publication, éventuellement pour un seul email, statut ou tier. Paginez avec limit, jusqu'à 100, et cursor : la réponse contient has_more et next_cursor.

Identifiant
beehiiv_list_subscriptions

L'appel

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>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
publicationIdstringOuiId of the publication, such as pub_..., from List publications.
emailstringNonOnly the subscription of this exact email, in any letter case.
statusstringNonOnly subscriptions in this status. pending waits for the double opt-in confirmation, inactive unsubscribed. The default is all.Valeurs : validating, invalid, pending, active, inactive, all
tierstringNonOnly free or premium subscriptions. The default is all.Valeurs : free, premium, all
creation_datestringNonOnly subscriptions created on this day, as YYYY/MM/DD.
order_bystringNonSort field, the creation time.Valeurs : created
directionstringNonSort direction. The default is asc.Valeurs : asc, desc
limitintegerNonSubscriptions per page, up to 100. The default is 10.
cursorstringNonNext page: the next_cursor of the previous response.

Connexions possibles

Votre client connecte son compte beehiiv une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/beehiiv_list_subscriptions. Il devient la définition de tool de votre agent sans conversion.

Autres tools beehiiv

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.