Documentation détaillée
Généralités
Authentification
Étapes de création d'un envoi e-mail
Étapes de création d'un envoi SMS
Nouveautés
administration du compte
abonnements
consentements
groupes d'intérêts
intérêts
champs
imports - mapping
imports
variables
ciblages
lois ciblages
critères ciblages
plannings
e-mail - adresses d'expéditeurs
e-mail - adresses de réponses
e-mail - liens de messages
e-mail - messages
e-mail - envois
e-mail - envois transactionnels
sms - expéditeurs
sms - messages
sms - envois
sms - envois transactionnels
exports - mappings
exports - colonnes
exports - filtres
exports
statistiques
hébergement
webhooks
connexions distantes
consentements - dépréciées
Powered by Stoplight
post

/contacts/search

Recherche des contacts en fonction d’un ou plusieurs filtres définis en paramètre.

Plusieurs options de recherche sont disponibles :

  • La pagination en renseignant le paramètre Offset et Limit
  • La recherche par contenu en utilisant SearchValue(chaine à rechercher) et SearchFieldIDList (champs de recherche)
  • Les filtres sur dates tels que la date d’abonnement, de désabonnement ou la date de dernière mise à jour du contact.

Veuillez noter que tous les identifiants de champs sont disponibles dans la méthode GET /fields.

Vous pouvez également personnaliser le retour de votre recherche en choisissant les champs de contacts que vous voulez voir afficher, pour cela, il suffit de les renseigner dans la propriété OutputFieldIDList.

Attention cette méthode renvoie 50 résultats au maximum. Utilisez les paramètres offset et limit pour paginer parmi les résultats de votre recherche.

Dernière mise à jour : Juin 2019

Authorization

apiKey - X-API-Key

Request Parameters

1 Query Parameter
1 Header

Request Body

Schema
object

Contact management

Query
object

Query

Responses

Success

Schema
object

DetailedList

Count
integer

Returned elements.

2 validations + required
Total
integer

Total elements (without filters).

2 validations + required
ItemList
array[object]

Items.

required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
X-API-Key