Lister les abonnés avec l'API Gumroad
Liste les abonnés d'un produit d'abonnement, avec e-mail, récurrence, statut (alive, pending_cancellation, failed_payment, cancelled et autres) et les ids de leurs ventes. Sans paginated, tous les abonnés arrivent dans une seule réponse.
- Identifiant
- gumroad_list_subscribers
L'appel
POST https://connect.reportei.com/api/tools/gumroad_list_subscribers/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"product_id": "<product_id>"
}
}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 |
|---|---|---|---|
| product_id | string | Oui | Id of a membership product, from List products. |
| string | Non | Email address of a subscriber: only that subscriber. | |
| paginated | boolean | Non | true returns 100 per page, with next_page_key when more follow. |
| page_key | string | Non | The next_page_key of the previous response. |
Connexions possibles
Votre client connecte son compte Gumroad 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.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/gumroad, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
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/gumroad_list_subscribers. Il devient la définition de tool de votre agent sans conversion.
Autres tools Gumroad
- Lister les produitsGETListe les produits du compte, du plus récent au plus ancien, 10 par page, sous forme abrégée : Obtenir un produit renvoie le produit complet. Quand il y en a plus, la réponse contient next_page_key, à passer dans page_key.
- Obtenir un produitGETRenvoie un produit avec prix, description, catégorie, tags, variantes, fichiers et, avec le scope view_sales, sales_count et sales_usd_cents.
- Lister les catégoriesGETListe les catégories de produit de Gumroad. Le path d'une catégorie, comme design/ui-and-web/figma, va dans category de Créer un produit et Mettre à jour un produit.
- Créer un produitPOSTCrée un produit et le publie immédiatement, sauf si draft vaut true. Quand la publication est bloquée, par exemple par un e-mail non confirmé ou l'absence de moyen de versement, le produit reste en brouillon et la réponse contient un warning : publiez-le plus tard avec Publier un produit.
- Mettre à jour un produitPUTModifie un produit et le renvoie. Seuls les champs envoyés changent, mais tags remplace toute la liste. Un warning dans la réponse signale les codes d'offre devenus invalides pour le produit.
- Publier un produitPUTPublie un brouillon ou un produit dépublié, pour que les acheteurs puissent l'acheter. Refusé tant que le compte n'a pas d'e-mail confirmé ou de moyen de versement, ou quand un code d'offre du produit rend le prix invalide.
- Dépublier un produitPUTDépublie un produit, ce qui arrête les nouvelles ventes. Publier un produit le remet en vente.
- Lister les ventesGETListe les ventes réussies du compte, des plus récentes aux plus anciennes, 10 par page, avec e-mail de l'acheteur, produit, prix, remboursement et données d'abonnement et de licence. Quand il y en a plus, la réponse contient next_page_key, à passer dans page_key.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
