Passer au contenu principal
Recherche paginée d’annonces (publications de biens) de votre périmètre, filtrable par transaction source et par statut.

Endpoint

URL : /external-integration/ad/search Méthode : GET Authentification : Requiert un token LinkedAPI avec scope externalIntegration et une clé rattachée à un groupe d’agences. Clé requise : toutes les clés (lecture seule suffit). Voir Types de clé.

Headers

Query Parameters

Pagination

  • Taille de page fixe : 50 annonces.
  • Itérez jusqu’à hasMore: false.
  • Le champ de taille de page de la réponse s’appelle ici pageSize — mais limit sur GET Contacts, GET Users et GET Transaction Search. Même sens, deux noms : lisez celui de la route que vous appelez.

Exemples de requête

Réponse de succès

Code : 200

Aucun résultat

Champs de la réponse

Chaque élément de ads reprend les mêmes champs que GET Ad (id, reference, status, title, surface, salePrice, location, pictures, transactionType, owner, etc.). Les champs non renseignés sont absents de la réponse.

Réponses d’erreur

  • status invalide : 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. Scope : seules les annonces de votre périmètre autorisé sont retournées.
  2. Pagination : 50 annonces par page. Itérez jusqu’à hasMore: false.
  3. Filtres : transaction et status sont combinables. Sans filtre, toutes les annonces du périmètre sont retournées.
  4. Médias : les pictures sont des URLs CloudFront publiques.
  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 :