Passer au contenu principal
Recherche paginée de transactions (sale, acquisition, rental) avec leurs contacts associés.

Endpoint

URL : /external-integration/{transaction}/search Méthode : GET Authentification : Requiert un token LinkedAPI avec scope externalIntegration (GET). Clé requise : toutes les clés (lecture seule suffit). Voir Types de clé. {transaction} ∈ sale | acquisition | rental.

Headers

Query Parameters

Aucun autre paramètre n’est accepté. Toute clé non listée (ou un filtre non supporté pour le type, ex. tags sur sale) → 400. Si search est fourni sans sortField, les résultats sont triés par pertinence (pas par createdAt).
Les filtres se combinent avec search et entre eux (logique « ET »). Un filtre répété (ex. plusieurs step) applique une logique « OU » sur ce filtre.
Synchronisation incrémentale. Chaque résultat porte updatedAt et stepUpdatedAt. Triez par sortField=updatedAt&sortOrder=desc et arrêtez de paginer dès que updatedAt passe sous la date de votre dernier passage : vous ne rapatriez que ce qui a changé, au lieu de tout repomper à chaque cycle.

Valeurs autorisées pour step

Pagination

  • Taille de page fixe : 100 documents.
  • Pas de total retourné. Itérez jusqu’à hasMore: false.
  • page max : 100 (= 10 000 documents cumulés). Au-delà, raffiner via search.
  • 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.

Clé de réponse selon le type

La clé contenant les résultats varie selon {transaction} :

Exemples de requête

Réponse de succès

Code : 200
Champs absents vs null : les champs non renseignés sur la fiche ne sont pas retournés (pas même à null). Côté client, traiter chaque champ comme optionnel sauf indication contraire. Le détail exhaustif des champs property, mandate, etc. est dans GET Sale.

Sale

Acquisition

Note de migration : les champs customId et step sont retournés pour acquisition et rental à partir du déploiement de cette version. Si votre intégration utilisait ces routes avant, ces deux champs étaient absents — vérifier que vous les récupérez désormais.

Rental

Aucun résultat

(La clé varie selon le type : sales / acquisitions / rentals.)

Réponses d’erreur

  • search < 3 caractères : 400 Bad Request
  • Paramètre inconnu : 400 Bad Request
  • sortField invalide : 400 Bad Request
  • page invalide ou hors limites : 400 Bad Request
  • step invalide pour le type : 400 Bad Request
  • owner / tags non ObjectId valide : 400 Bad Request
  • Filtre non supporté pour le type (ex. tags sur sale) : 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. Les résultats sont limités à votre périmètre autorisé. Une fiche hors périmètre n’apparaîtra jamais dans la réponse.
  2. Recherche minimum 3 caractères. Les mots vides FR (de, la, le…) ne sont pas pris en compte.
  3. Lorsque search est fourni sans sortField, l’ordre par défaut est la pertinence. Pour un ordre déterministe, passer sortField explicitement.
  4. Les contacts inclus reflètent l’état au moment de la dernière mise à jour de la transaction.
  5. Endpoint en lecture seule.

Rate limits

Chaque route est limitée à 200 req / minute par groupe d’agences (un compteur par groupe d’agences × route : sale/search, acquisition/search et rental/search ont chacun leur propre compteur).
  • Headers : RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset (secondes).
  • Dépassement → 429 Too Many Requests :