Passer au contenu principal
Liste paginée de contacts par téléphone, email, ou texte libre. Ne retourne pas les transactions associées — uniquement les contacts.

Endpoint

URL : /external-integration/contacts Méthode : GET Authentification : Requiert un token LinkedAPI avec agencyGroup configuré. Clé requise : toutes les clés (lecture seule suffit). Voir Types de clé.

Headers

Query Parameters

Exactement un des trois paramètres suivants doit être fourni : Paramètres supplémentaires :
phone, email, search sont mutuellement exclusifs. Zéro ou plus d’un → 400. Toute clé de query non listée → 400.

Pagination

  • Taille de page fixe : 100 contacts.
  • Pas de total retourné. Itérez jusqu’à hasMore: false.
  • page max : 100 (= 10 000 contacts cumulés).
  • Le champ de taille de page de la réponse s’appelle ici limit — mais pageSize sur GET Activities et GET Ad Search. Même sens, deux noms : lisez celui de la route que vous appelez.

Différences avec /external-integration/contact

Exemples de requête

Réponse de succès

Code : 200

Aucun résultat

Réponses d’erreur

  • Aucun paramètre fourni : 400 Bad Request
  • Plusieurs paramètres fournis : 400 Bad Request
  • Paramètre de query inconnu : 400 Bad Request
  • Téléphone invalide : 400 Bad Request
  • Email invalide : 400 Bad Request
  • search < 3 caractères : 400 Bad Request
  • page hors limites : 400 Bad Request
  • LinkedAPI agencyGroup manquant : 400 Bad Request
  • Header Authorization absent, ou IP non whitelistée sur une clé sécurisée : 403 Not authorized to access this resource
  • Token invalide : 401 Invalid bearer token

Notes

  1. Mode phone / email : matching exact. Tri par createdAt desc.
  2. Mode search : tri par pertinence.
  3. Scope : les contacts sont limités à votre périmètre autorisé.
  4. Pas de transactions : utiliser /external-integration/contact (singulier) pour obtenir un contact + ses transactions associées.
  5. Endpoint en lecture seule.

Rate limits

Cette route est limitée à 200 req / minute par groupe d’agences (bucket dédié).
  • Headers : RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset (secondes avant reset).
  • Dépassement → 429 Too Many Requests avec header Retry-After :