Lister les contacts avec l'API Omnisend

Liste les contacts avec id, email, phone, status, tags, segments et propriétés personnalisées, du plus récent au plus ancien par défaut. La réponse contient contacts et paging ; tant que paging.hasMore vaut true, passez paging.cursors.after comme after et gardez les filtres.

Identifiant
omnisend_list_contacts

L'appel

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

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

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
emailstringNonOnly the contact with this email address.
phonestringNonOnly the contact with this phone number, in E.164 format such as +5511999998888.
statusstringNonOnly the contacts with this email subscription status. Does not work together with tag.Valeurs : subscribed, unsubscribed, nonSubscribed
tagstringNonOnly the contacts with this tag. Does not work together with status.
segmentIDstringNonOnly the contacts of this segment, by the segmentID from List segments.
updatedAtFromstringNonOnly the contacts updated at or after this RFC 3339 date-time. Does not work together with the other filters.
sortstringNonField to sort by. The default is createdAt.Valeurs : createdAt, updatedAt
directionstringNonOrder of the sort, used only with sort. The default is desc.Valeurs : asc, desc
limitintegerNonContacts per page, up to 250. The default is 100.
afterstringNonThe paging.cursors.after of the previous page.

Connexions possibles

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

Autres tools Omnisend

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