# Avest API > Documentation de l'API d'intégration externe Avest - [Introduction](https://developers.avest.fr/introduction.md): L'API d'intégration externe Avest : créer et synchroniser vos transactions, contacts et utilisateurs. - [Authentification](https://developers.avest.fr/guides/authentification.md): Comment authentifier vos requêtes à l'API d'intégration externe Avest. - [Déduplication & allocation](https://developers.avest.fr/guides/deduplication.md): Comment les endpoints de création dédupliquent contacts et transactions, et attribuent agence et utilisateur. - [Consentement à la prospection](https://developers.avest.fr/guides/consentement.md): Transmettre le consentement d'un contact à la création et à la mise à jour : canaux, parcours déclaré, durées et traçabilité. - [GET Contact](https://developers.avest.fr/endpoints/get-contact.md): Recherche un contact par téléphone, email ou texte libre et retourne ses transactions associées. - [GET Contacts](https://developers.avest.fr/endpoints/get-contacts.md): Liste paginée de contacts par téléphone, email ou texte libre, sans les transactions associées. - [POST Contact](https://developers.avest.fr/endpoints/post-contact.md): Crée un contact seul. À n'utiliser qu'en dernier recours : privilégiez la création du contact AVEC sa transaction. - [PATCH Contact](https://developers.avest.fr/endpoints/patch-contact.md): Met à jour les champs d'identité et le consentement d'un contact existant. Chaque modification est tracée (activité d'audit). - [GET Key](https://developers.avest.fr/endpoints/get-key.md): Connaître le type de votre clé API et les méthodes qu'elle autorise, avant qu'un 403 vous l'apprenne. - [GET Agencies](https://developers.avest.fr/endpoints/get-agencies.md): Liste les agences accessibles par votre clé (et le groupe d'agences). - [GET User](https://developers.avest.fr/endpoints/get-user.md): Récupère un utilisateur (collaborateur) par son identifiant pour résoudre un owner. - [GET Users](https://developers.avest.fr/endpoints/get-users.md): Liste paginée des utilisateurs (collaborateurs) de votre périmètre — l'annuaire complet. - [Planning de permanence](https://developers.avest.fr/endpoints/shift-planning.md): Alimenter et relire le planning de permanence d'une agence depuis votre propre outil. - [GET Transaction Search](https://developers.avest.fr/endpoints/get-transaction-search.md): Recherche paginée de transactions (sale, acquisition, rental) avec leurs contacts associés. - [GET Sale](https://developers.avest.fr/endpoints/get-sale.md): Récupère une vente par son id Mongo ou son customId métier, avec ses contacts liés. - [GET Acquisition](https://developers.avest.fr/endpoints/get-acquisition.md): Récupère une acquisition par son id Mongo ou son customId métier, avec ses contacts liés. - [GET Rental](https://developers.avest.fr/endpoints/get-rental.md): Récupère une location par son id Mongo ou son customId métier, avec ses contacts liés. - [POST Sale](https://developers.avest.fr/endpoints/post-sale.md): Crée ou met à jour une vente avec déduplication automatique du contact et de la transaction. - [POST Acquisition](https://developers.avest.fr/endpoints/post-acquisition.md): Crée ou met à jour une acquisition avec déduplication et matching optionnel d'une vente. - [POST Rental](https://developers.avest.fr/endpoints/post-rental.md): Crée ou met à jour une location avec déduplication automatique du contact et de la transaction. - [PATCH Sale](https://developers.avest.fr/endpoints/patch-sale.md): Met à jour une vente existante en la ciblant par son identifiant, sans risque de doublon. - [PATCH Acquisition](https://developers.avest.fr/endpoints/patch-acquisition.md): Corrige les critères de recherche d'une fiche acquéreur existante. - [Qualifier un acquéreur](https://developers.avest.fr/endpoints/post-acquisition-qualify.md): Fait sortir une fiche acquéreur de « à qualifier » : en recherche, ou archivée. - [GET Match](https://developers.avest.fr/endpoints/get-match.md): Récupère un match (rapprochement acquisition / vente) par son id ou son customId. - [GET Match Search](https://developers.avest.fr/endpoints/get-match-search.md): Recherche les matchs rattachés à une vente et/ou une acquisition. - [PATCH Match](https://developers.avest.fr/endpoints/patch-match.md): Fait avancer l'étape d'une mise en relation, ou la classe sans suite. - [Visites & offres](https://developers.avest.fr/endpoints/visits-offers.md): Lire les visites et les offres d'une mise en relation (match) via les activités. - [Visites d'un match](https://developers.avest.fr/endpoints/match-visits.md): Lire, créer, modifier et annuler les visites rattachées à une mise en relation. - [Offres d'un match](https://developers.avest.fr/endpoints/match-offers.md): Lire, créer et faire évoluer les offres rattachées à une mise en relation. - [GET Activities](https://developers.avest.fr/endpoints/get-activities.md): Liste paginée des activités rattachées à un document (annonce, transaction, match ou contact). - [POST Activity](https://developers.avest.fr/endpoints/post-activity.md): Crée une activité (note, tâche, appel, message, email, rendez-vous) sur une fiche existante : acquisition, vente, location ou contact. - [PATCH Activity](https://developers.avest.fr/endpoints/patch-activity.md): Clôture un rappel honoré depuis votre outil, ou le rouvre — pour que les relances du négociateur restent à jour. Corrige aussi le texte d'une note. - [DELETE Activity](https://developers.avest.fr/endpoints/delete-activity.md): Supprime une note depuis votre outil — une note créée par erreur ne reste plus sur la fiche. - [GET Ad](https://developers.avest.fr/endpoints/get-ad.md): Récupère une annonce par son id ou sa référence, avec contact, localisation et médias. - [GET Ad Search](https://developers.avest.fr/endpoints/get-ad-search.md): Recherche paginée d'annonces, filtrable par transaction source et par statut. - [Récupérer un contact et ses transactions](https://developers.avest.fr/api-reference/contacts/récupérer-un-contact-et-ses-transactions.md): Recherche un contact par téléphone, email, ou texte libre, et retourne ses transactions associées (ventes, acquisitions, locations). - [Créer un contact seul](https://developers.avest.fr/api-reference/contacts/créer-un-contact-seul.md): Crée un contact **seul** dans une agence du périmètre du token. - [Lister des contacts (paginé)](https://developers.avest.fr/api-reference/contacts/lister-des-contacts-paginé.md): Liste paginée de contacts par téléphone, email, ou texte libre. Ne retourne **pas** les transactions associées — uniquement les contacts. Pour un contact + ses transactions, utiliser `GET /external-integration/contact` (singulier). - [Mettre à jour un contact](https://developers.avest.fr/api-reference/contacts/mettre-à-jour-un-contact.md): Met à jour les champs d'identité et le consentement d'un contact existant du périmètre du token. Chaque champ modifié génère une activité d'audit (`ATTRIBUTE_UPDATE`) sur la fiche. Au moins un champ doit être fourni : un objet `consent` seul suffit. Voir le guide [Consentement à la prospection](/gui… - [Connaître le type de sa clé](https://developers.avest.fr/api-reference/key/connaître-le-type-de-sa-clé.md): Renvoie le type de la clé utilisée (`readOnly`, `readWrite`, `readWriteDelete`, ou `custom` pour certaines clés anciennes) et la liste exacte des méthodes HTTP qu'elle autorise. Une méthode absente de `methods` reçoit `403`. Accessible à toute clé. Le token et l'IP autorisée ne sont jamais renvoyés. - [Lister les agences accessibles](https://developers.avest.fr/api-reference/agencies/lister-les-agences-accessibles.md): Liste les agences du périmètre du token et le groupe d'agences. Utile pour récupérer les `agencyId` valides à passer à `POST /external-integration/contact` et les valeurs de `settings.allocation` à la création d'un lead. Une agence ouverte dans le groupe après la création de la clé y figure, sans dé… - [Récupérer un collaborateur par identifiant](https://developers.avest.fr/api-reference/users/récupérer-un-collaborateur-par-identifiant.md): Récupère un utilisateur (collaborateur) par son identifiant. Pratique pour résoudre un `owner` (présent sur les ventes, acquisitions, locations et contacts) en nom, prénom et photo. - [Lister les collaborateurs (paginé)](https://developers.avest.fr/api-reference/users/lister-les-collaborateurs-paginé.md): Liste paginée des collaborateurs de tout votre groupe d'agences, y compris ceux d'agences que votre clé ne couvre pas. La réponse ne dit pas à quelle agence chacun appartient. Permet de récupérer en une fois l'annuaire des collaborateurs : nom, prénom, téléphone, photo, fonction, statut. - [Relire le planning de permanence d'une semaine](https://developers.avest.fr/api-reference/shift-planning/relire-le-planning-de-permanence-dune-semaine.md): Renvoie les créneaux de permanence **datés** d'une semaine ISO, pour une agence et un type de transaction. Sert à vérifier ce qui a été poussé avant que cela pilote l'attribution des leads. - [Alimenter le planning de permanence d'une semaine](https://developers.avest.fr/api-reference/shift-planning/alimenter-le-planning-de-permanence-dune-semaine.md): Remplace le planning de permanence d'**une** semaine ISO pour une agence et un type de transaction. Le corps décrit l'**état complet** de la semaine : tout créneau absent de `shifts` est supprimé. Rejouer le même corps donne le même résultat. - [Rechercher des transactions (paginé)](https://developers.avest.fr/api-reference/transactions/rechercher-des-transactions-paginé.md): Recherche paginée de transactions (`sale`, `acquisition`, `rental`) avec leurs contacts associés. - [Récupérer une transaction par id ou customId](https://developers.avest.fr/api-reference/transactions/récupérer-une-transaction-par-id-ou-customid.md): Récupère une transaction (`sale`, `acquisition`, `rental`) par son `id` MongoDB ou son `customId` métier, avec ses contacts liés. - [Mettre à jour les critères d'une acquisition](https://developers.avest.fr/api-reference/transactions/mettre-à-jour-les-critères-dune-acquisition.md): Corrige les critères de recherche d'une fiche acquéreur existante sans repasser par le pipeline leadgen. - [Mettre à jour une vente ciblée par identifiant](https://developers.avest.fr/api-reference/transactions/mettre-à-jour-une-vente-ciblée-par-identifiant.md): Met à jour une vente existante en la **ciblant par son identifiant**, ce qui supprime tout risque de doublon. - [Qualifier un prospect acquéreur](https://developers.avest.fr/api-reference/transactions/qualifier-un-prospect-acquéreur.md): Sort une fiche de l'étape « à qualifier » (`AQUL`) vers `ASRC` (en recherche) ou `AARC` (archivée). - [Créer ou mettre à jour une vente](https://developers.avest.fr/api-reference/lead-generation/créer-ou-mettre-à-jour-une-vente.md): Crée ou met à jour une vente (estimation / mandat vendeur) avec déduplication automatique du contact et de la transaction. - [Créer ou mettre à jour une acquisition](https://developers.avest.fr/api-reference/lead-generation/créer-ou-mettre-à-jour-une-acquisition.md): Crée ou met à jour une acquisition (fiche acquéreur) avec déduplication automatique du contact et de la transaction, et possibilité de créer un match avec une vente existante. - [Créer ou mettre à jour une location](https://developers.avest.fr/api-reference/lead-generation/créer-ou-mettre-à-jour-une-location.md): Crée ou met à jour une location (fiche bailleur / gestion locative) avec déduplication automatique du contact et de la transaction. - [Récupérer un rapprochement par id ou customId](https://developers.avest.fr/api-reference/matches/récupérer-un-rapprochement-par-id-ou-customid.md): Récupère un rapprochement (match vente / acquisition) par son `id` MongoDB ou son `customId` métier. - [Rechercher des rapprochements](https://developers.avest.fr/api-reference/matches/rechercher-des-rapprochements.md): Recherche des rapprochements (matches) par vente et/ou acquisition. - [Faire avancer l'étape d'une mise en relation](https://developers.avest.fr/api-reference/matches/faire-avancer-létape-dune-mise-en-relation.md): Fait progresser un match dans l'entonnoir commercial. Seule l'étape est modifiable. - [Lister les visites d'une mise en relation](https://developers.avest.fr/api-reference/matches/lister-les-visites-dune-mise-en-relation.md): Visites du match, triées par `data.visitStartAt` décroissant, enrichies d'un `data.derivedStatus` (`planned`, `completed`, `cancelled`). - [Créer une visite sur une mise en relation](https://developers.avest.fr/api-reference/matches/créer-une-visite-sur-une-mise-en-relation.md): Crée une visite datée. **Effet de bord** : le match est promu à l'étape `MVST` s'il était à une étape antérieure. - [Modifier ou annuler une visite](https://developers.avest.fr/api-reference/matches/modifier-ou-annuler-une-visite.md): Déplace, annote, réattribue ou annule une visite. **Effet de bord** : annuler la dernière visite active redescend le match à `MCNV`. - [Lister les offres d'une mise en relation](https://developers.avest.fr/api-reference/matches/lister-les-offres-dune-mise-en-relation.md): Offres du match, triées par `data.offerDate` décroissant. En charge partagée (`feeResponsibility: both`), une offre saisie dans Avest peut porter la part vendeur des honoraires : `data.sellerAgencyCommission`, et `data.sellerAgencyCommissionPercentage` en mode pourcentage. Ces champs ne s'écrivent p… - [Créer une offre sur une mise en relation](https://developers.avest.fr/api-reference/matches/créer-une-offre-sur-une-mise-en-relation.md): Crée une offre. `offerDate` est requis, ainsi qu'au moins un de `sellPrice` / `agencyCommission`. **Effet de bord** : le match est promu à `MOFF` s'il était à une étape antérieure. - [Faire évoluer une offre](https://developers.avest.fr/api-reference/matches/faire-évoluer-une-offre.md): Met à jour le statut ou les montants d'une offre. Un statut terminal peut classer le match « sans suite ». `accepted` est refusé. - [Lister les activités d'un document (paginé)](https://developers.avest.fr/api-reference/activities/lister-les-activités-dun-document-paginé.md): Liste paginée des activités (notes, tâches, appels, emails, changements d'étape, etc.) liées à un document Avest (vente, acquisition, location, annonce, match ou contact). - [Créer une activité sur un document](https://developers.avest.fr/api-reference/activities/créer-une-activité-sur-un-document.md): Crée une activité (note, tâche, appel, message, email, rendez-vous) sur un document existant : acquisition (fiche acquéreur), vente, location ou contact. - [Supprimer une note](https://developers.avest.fr/api-reference/activities/supprimer-une-note.md): Supprime définitivement une activité de type **`note`**, avec les mêmes effets qu'une suppression depuis l'interface Avest. La suppression est irréversible. - [Clôturer, rouvrir une activité ou corriger une note](https://developers.avest.fr/api-reference/activities/clôturer-rouvrir-une-activité-ou-corriger-une-note.md): Met à jour une activité existante — principalement pour **clôturer un rappel** honoré depuis un outil tiers, afin qu'il cesse de remonter dans les relances du négociateur. - [Récupérer une annonce par id ou référence](https://developers.avest.fr/api-reference/ads/récupérer-une-annonce-par-id-ou-référence.md): Récupère une annonce (listing publique) par son `id` MongoDB ou sa `reference` métier. - [Rechercher des annonces (paginé)](https://developers.avest.fr/api-reference/ads/rechercher-des-annonces-paginé.md): Recherche paginée d'annonces, filtrable par transaction liée et par statut. - [Changelog](https://developers.avest.fr/changelog.md): Historique des évolutions de l'API d'intégration externe Avest. ## OpenAPI Specs - [openapi](/openapi.yaml) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.