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
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.
Valeurs autorisées pour step
Pagination
- Taille de page fixe : 100 documents.
- Pas de
totalretourné. Itérez jusqu’àhasMore: false. pagemax : 100 (= 10 000 documents cumulés). Au-delà, raffiner viasearch.- Le champ de taille de page de la réponse s’appelle ici
limit— maispageSizesur 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
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
sales / acquisitions / rentals.)
Réponses d’erreur
search< 3 caractères :400 Bad Request
- Paramètre inconnu :
400 Bad Request
sortFieldinvalide :400 Bad Request
pageinvalide ou hors limites :400 Bad Request
stepinvalide pour le type :400 Bad Request
owner/tagsnon ObjectId valide :400 Bad Request
- Filtre non supporté pour le type (ex.
tagssursale) :400 Bad Request
- Header
Authorizationabsent, 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
- 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.
- Recherche minimum 3 caractères. Les mots vides FR (
de,la,le…) ne sont pas pris en compte. - Lorsque
searchest fourni sanssortField, l’ordre par défaut est la pertinence. Pour un ordre déterministe, passersortFieldexplicitement. - Les contacts inclus reflètent l’état au moment de la dernière mise à jour de la transaction.
- 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: