Rechercher des contacts avec l'API GetResponse

Recherche les contacts d'une ou plusieurs campagnes (listes de contacts) par statut d'abonnement et, en option, par email ou nom. Les contacts en double opt-in non confirmés n'apparaissent qu'ici. Paginez avec page et perPage, jusqu'à 1000 ; une page plus courte que perPage est la dernière.

Identifiant
getresponse_search_contacts

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "subscribersType": [],
    "sectionLogicOperator": "or",
    "section": []
  }
}

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
subscribersTypearrayOuiOne subscription status: subscribed, unconfirmed (double opt-in not confirmed yet), undelivered, or removed for the unsubscribed.
sectionLogicOperatorstringOuiHow the sections combine: or matches any section, and matches all of them.Valeurs : or, and
sectionarrayOuiUp to 8 groups of criteria. In each, campaignIdsList has the campaignId values from List campaigns; subscriberCycle with both values ignores the autoresponder cycle; subscriptionDate all_time ignores the date, and custom needs customDate. conditions is optional: up to 8 conditions on email or name, with operatorType string_operator, such as conditionType email, operator is and the address as value.
fieldsstringNonFields to return, comma-separated, such as email,name,campaign. contactId always comes back.
perPageintegerNonContacts per page, up to 1000. The default is 100.
pageintegerNonPage number, starting at 1.

Connexions possibles

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

Autres tools GetResponse

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.