curl --request GET \
--url https://api.avest.fr/v1/external-integration/contact \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.avest.fr/v1/external-integration/contact"
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/contact', 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/contact",
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/contact"
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/contact")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avest.fr/v1/external-integration/contact")
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,
"contact": {
"id": "618a35a36d932054e195ca0a",
"firstName": "Jean",
"lastName": "Dupont",
"contactDetails": [
{
"type": "phone",
"data": "+33612345678"
},
{
"type": "email",
"data": "jean.dupont@email.com"
}
]
},
"sales": [
{
"id": "619b46b47e043165f206db1b",
"customId": "V-2025-001",
"step": "QUL",
"project": "B"
}
],
"acquisitions": [
{
"id": "619b46b47e043165f206db1c",
"customId": "A-2025-001",
"step": "AQUL",
"project": "B"
}
],
"rentals": []
}Récupérer un contact et ses transactions
Recherche un contact par téléphone, email, ou texte libre, et retourne ses transactions associées (ventes, acquisitions, locations).
Exactement un des trois paramètres phone, email, search doit être fourni — ils sont mutuellement exclusifs. Zéro ou plus d’un → 400. Toute clé de query non listée → 400.
En mode phone / email, le match est exact (email normalisé en minuscules) ; retourne null si aucun contact ne correspond. En mode search, seul le meilleur résultat est retourné. Les résultats sont limités au périmètre autorisé du token. Endpoint en lecture seule.
curl --request GET \
--url https://api.avest.fr/v1/external-integration/contact \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.avest.fr/v1/external-integration/contact"
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/contact', 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/contact",
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/contact"
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/contact")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avest.fr/v1/external-integration/contact")
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,
"contact": {
"id": "618a35a36d932054e195ca0a",
"firstName": "Jean",
"lastName": "Dupont",
"contactDetails": [
{
"type": "phone",
"data": "+33612345678"
},
{
"type": "email",
"data": "jean.dupont@email.com"
}
]
},
"sales": [
{
"id": "619b46b47e043165f206db1b",
"customId": "V-2025-001",
"step": "QUL",
"project": "B"
}
],
"acquisitions": [
{
"id": "619b46b47e043165f206db1c",
"customId": "A-2025-001",
"step": "AQUL",
"project": "B"
}
],
"rentals": []
}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 requête
Réponse
Contact trouvé (ou null si aucun match).