Lister les clients avec l'API Baremetrics

Liste les clients d'une source avec oid, e-mail, LTV et MRR actuel en centimes, plans actuels et s'ils sont actifs ou résiliés. La réponse a meta.pagination.has_more ; envoyez page pour lire la page suivante.

Identifiant
baremetrics_list_customers

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "source_id": "<source_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ètreTypeObligatoireDescription
source_idstringOuiId of the source, from List sources.
searchstringNonText matched against the oid, email, notes and name of the customer.
sortstringNonSort field. The default is created.Valeurs : created, ltv
orderstringNonSort order. The default is asc.Valeurs : asc, desc
pageintegerNonPage to read. The first page is 0.
per_pageintegerNonCustomers per page, up to 200. The default is 30.

Connexions possibles

Votre client connecte son compte Baremetrics 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/baremetrics_list_customers. Il devient la définition de tool de votre agent sans conversion.

Autres tools Baremetrics

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.