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ètre | Type | Obligatoire | Description |
|---|---|---|---|
| publicationId | string | Oui | Id of the publication, such as pub_..., from List publications. |
| string | Non | Only the subscription of this exact email, in any letter case. | |
| status | string | Non | Only 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 |
| tier | string | Non | Only free or premium subscriptions. The default is all.Valeurs : free, premium, all |
| creation_date | string | Non | Only subscriptions created on this day, as YYYY/MM/DD. |
| order_by | string | Non | Sort field, the creation time.Valeurs : created |
| direction | string | Non | Sort direction. The default is asc.Valeurs : asc, desc |
| limit | integer | Non | Subscriptions per page, up to 100. The default is 10. |
| cursor | string | Non | Next 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
- Lister les publicationsGETListe les publications accessibles avec la API key, avec id, name et organization_name. expand stats ajoute les abonnements actifs, les taux moyens d'ouverture et de clic et les totaux envoyés. Paginez avec page et limit, jusqu'à 100 ; la réponse contient total_pages.
- Obtenir un abonnementGETRenvoie un abonnement avec email, status, created, subscription_tier, les champs utm et referral_code.
- Créer un abonnementPOSTAbonne un email à une publication et renvoie l'abonnement avec son id. Avec le double opt-in sur la publication, ou double_opt_override activé, la personne confirme par email avant de devenir active.
- Mettre à jour un abonnementPATCHMet à jour un abonnement. Seuls les champs envoyés changent. unsubscribe true désabonne la personne de la publication.
- Créer un tag d'abonnementPOSTAjoute des tags à un abonnement. Un tag qui n'existe pas encore dans la publication est créé.
- Lister les postsGETListe les posts d'une publication avec id, title, subtitle, status, publish_date et web_url. expand stats ajoute les statistiques email et web de chaque post. Paginez avec page et limit, jusqu'à 100 ; la réponse contient total_pages.
- Obtenir un postGETRenvoie un post ; expand stats ajoute ses statistiques email et web. Un post créé à l'instant peut répondre 202 pendant que beehiiv le construit, et 404 avec POST_CREATION_FAILED quand la création a échoué.
- Créer un postPOSTCrée un post à partir de HTML et renvoie son id ; uniquement sur les plans Pro et Enterprise. status draft, la valeur par défaut, l'enregistre seulement ; confirmed l'envoie et le publie tout de suite ou à scheduled_at. beehiiv construit le post en arrière-plan, donc Get post peut répondre 202 un instant.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
