Lister les abonnés avec l'API Kit

Liste les abonnés avec id, e-mail, prénom, état et champs personnalisés, seulement les actifs par défaut. Recherchez-en un par email_address. La réponse contient subscribers et pagination ; tant que has_next_page vaut true, passez pagination.end_cursor en after.

Identifiant
kit_list_subscribers

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "email_address": "<email_address>"
  }
}

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
email_addressstringNonOnly the subscriber with exactly this email address. Does not work together with an engagement sort_field.
statusstringNonOnly the subscribers in this state. The default is active, and all returns every state.Valeurs : active, inactive, bounced, complained, cancelled, all
created_afterstringNonOnly the subscribers created after this date, as YYYY-MM-DD.
created_beforestringNonOnly the subscribers created before this date, as YYYY-MM-DD.
updated_afterstringNonOnly the subscribers updated after this date, as YYYY-MM-DD.
updated_beforestringNonOnly the subscribers updated before this date, as YYYY-MM-DD.
sort_fieldstringNonField to sort by. The default is id. The engagement fields count the last 90 days, and cancelled_at needs status cancelled.Valeurs : id, created_at, updated_at, cancelled_at, engagement__sent, engagement__opens, engagement__clicks, engagement__open_rate, engagement__click_rate
sort_orderstringNonOrder of the sort.Valeurs : asc, desc
includestringNonExtra fields on each subscriber, separated by commas: attribution, tags, location, and canceled_at, which needs status cancelled.
per_pageintegerNonSubscribers per page, up to 1000. The default is 500.
afterstringNonThe pagination.end_cursor of the previous page.

Connexions possibles

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

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/kit, 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/kit_list_subscribers. Il devient la définition de tool de votre agent sans conversion.

Autres tools Kit

Voir les 13 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.