curl --request GET \
--url https://api.avest.fr/v1/external-integration/{transaction} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.avest.fr/v1/external-integration/{transaction}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.avest.fr/v1/external-integration/{transaction}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.avest.fr/v1/external-integration/{transaction}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.avest.fr/v1/external-integration/{transaction}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.avest.fr/v1/external-integration/{transaction}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avest.fr/v1/external-integration/{transaction}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"sale": {
"id": "6a044cba8db14b3fbd015208",
"customId": "BCOU2162",
"agency": "66cc91d475c9fac35c86ed80",
"agencyGroup": "66cc8a8e75c9fac35c6ecd73",
"step": "MND",
"status": "awaitingLaunch",
"project": "B",
"property": {
"mainType": "apartment",
"developmentType": "old",
"size": 65,
"floor": 3,
"rooms": 3,
"bedrooms": 2,
"bathrooms": 1,
"isCollectiveOwnership": true,
"addressData": {
"streetNumber": "3",
"route": "Avenue Reille",
"postalCode": "75014",
"city": "Paris",
"country": "France",
"countryCode": "FR",
"formattedAddress": "3 Av. Reille, 75014 Paris, France"
}
},
"mandate": {
"price": 252000,
"sellPrice": 240000,
"agencyCommission": 12000,
"type": "notExclusive",
"referenceNumber": "1729",
"feeResponsibility": "seller",
"commissionPercentage": 4.76,
"commissionType": "value",
"mandateDuration": 3,
"maxMandateDuration": 12
},
"timeline": {
"mandateSignatureDate": "2026-05-13T14:59:03.596Z"
},
"createdAt": "2026-05-13T10:04:42.139Z",
"owner": {
"id": "6939530d9200187f19a2707d",
"firstName": "Florian",
"lastName": "PUJO",
"picture": "https://cdn.avest.fr/attachment/user/696e2f1adff893e4465d15b3"
},
"mainContact": "6a044cadd494814278d1fb84"
},
"contacts": [
{
"id": "6a044cadd494814278d1fb84",
"title": "mr",
"firstName": "Olivier",
"lastName": "BOYER",
"isIndividual": true,
"contactDetails": [
{
"type": "email",
"data": "olivier.boyer@example.fr"
},
{
"type": "phone",
"data": "+33660598726"
}
]
}
]
}Récupérer une transaction par id ou customId
Récupère une transaction (sale, acquisition, rental) par son id MongoDB ou son customId métier, avec ses contacts liés.
La clé de réponse dépend du type demandé : sale, acquisition ou rental. Exactement un des deux paramètres id / customId doit être fourni — pas zéro, pas les deux.
La fiche n’est retournée que si elle appartient à la agencyGroup du token ET à une des agencies du LinkedAPI. Une fiche hors scope retourne le même payload null qu’une fiche inexistante (pas de différenciation 404 vs 403). Le contact principal est exposé via mainContact (ID) ; le détail complet est dans la clé contacts au top-level. Les champs non renseignés sont absents (pas null). Endpoint en lecture seule.
curl --request GET \
--url https://api.avest.fr/v1/external-integration/{transaction} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.avest.fr/v1/external-integration/{transaction}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.avest.fr/v1/external-integration/{transaction}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.avest.fr/v1/external-integration/{transaction}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.avest.fr/v1/external-integration/{transaction}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.avest.fr/v1/external-integration/{transaction}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avest.fr/v1/external-integration/{transaction}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"sale": {
"id": "6a044cba8db14b3fbd015208",
"customId": "BCOU2162",
"agency": "66cc91d475c9fac35c86ed80",
"agencyGroup": "66cc8a8e75c9fac35c6ecd73",
"step": "MND",
"status": "awaitingLaunch",
"project": "B",
"property": {
"mainType": "apartment",
"developmentType": "old",
"size": 65,
"floor": 3,
"rooms": 3,
"bedrooms": 2,
"bathrooms": 1,
"isCollectiveOwnership": true,
"addressData": {
"streetNumber": "3",
"route": "Avenue Reille",
"postalCode": "75014",
"city": "Paris",
"country": "France",
"countryCode": "FR",
"formattedAddress": "3 Av. Reille, 75014 Paris, France"
}
},
"mandate": {
"price": 252000,
"sellPrice": 240000,
"agencyCommission": 12000,
"type": "notExclusive",
"referenceNumber": "1729",
"feeResponsibility": "seller",
"commissionPercentage": 4.76,
"commissionType": "value",
"mandateDuration": 3,
"maxMandateDuration": 12
},
"timeline": {
"mandateSignatureDate": "2026-05-13T14:59:03.596Z"
},
"createdAt": "2026-05-13T10:04:42.139Z",
"owner": {
"id": "6939530d9200187f19a2707d",
"firstName": "Florian",
"lastName": "PUJO",
"picture": "https://cdn.avest.fr/attachment/user/696e2f1adff893e4465d15b3"
},
"mainContact": "6a044cadd494814278d1fb84"
},
"contacts": [
{
"id": "6a044cadd494814278d1fb84",
"title": "mr",
"firstName": "Olivier",
"lastName": "BOYER",
"isIndividual": true,
"contactDetails": [
{
"type": "email",
"data": "olivier.boyer@example.fr"
},
{
"type": "phone",
"data": "+33660598726"
}
]
}
]
}Autorisations
Token LinkedAPI avec scope externalIntegration. La clé doit avoir un agencyGroup configuré (sinon 400 LinkedAPI agencyGroup is required). Fourni via l'en-tête Authorization: Bearer {linkedAPI_token}. Si la clé a secure === true, l'IP appelante doit être whitelistée (en-tête X-Real-IP), sinon 403 Not authorized to access this resource.
La clé porte aussi un niveau d'accès : en lecture seule, elle n'autorise que les GET ; un POST ou un PATCH renvoie alors 403 Not authorized to access this resource, soit la même réponse qu'une requête sans en-tête Authorization. Voir le guide Authentification.
Paramètres de chemin
Paramètres de requête
Réponse
Transaction trouvée (ou null si hors scope / inexistante). La clé sale / acquisition / rental dépend du type demandé.
La clé de la transaction (sale / acquisition / rental) dépend du type demandé ; elle vaut null si non trouvée ou hors scope.