curl --request GET \
--url https://api.avest.fr/v1/external-integration/users \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.avest.fr/v1/external-integration/users"
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/users', 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/users",
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/users"
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/users")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avest.fr/v1/external-integration/users")
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,
"users": [
{
"id": "618a35a36d932054e195ca0a",
"firstName": "Thomas",
"lastName": "Godard",
"phone": "+33612345678",
"picture": "https://static.example.com/user/618a35a36d932054e195ca0a.jpg",
"jobTitle": "Directeur",
"agentStatus": "independent",
"agentRegistrationNumber": "CPI 3101 2020 000 012 345"
},
{
"id": "618a35a36d932054e195ca0b",
"firstName": "Marie",
"lastName": "Martin",
"phone": "+33698765432",
"jobTitle": "Conseillère",
"agentStatus": "employee"
}
],
"page": 1,
"limit": 100,
"hasMore": false
}Lister les collaborateurs (paginé)
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.
Toute clé de query non listée → 400. Taille de page fixe : 100 utilisateurs. Pas de total retourné — itérer jusqu’à hasMore: false. page max : 100. Tri par nom puis prénom.
Bonne pratique : récupérer l’annuaire une seule fois (et le mettre en cache) plutôt que d’interroger /external-integration/user?id=... en boucle. Endpoint en lecture seule.
curl --request GET \
--url https://api.avest.fr/v1/external-integration/users \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.avest.fr/v1/external-integration/users"
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/users', 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/users",
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/users"
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/users")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avest.fr/v1/external-integration/users")
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,
"users": [
{
"id": "618a35a36d932054e195ca0a",
"firstName": "Thomas",
"lastName": "Godard",
"phone": "+33612345678",
"picture": "https://static.example.com/user/618a35a36d932054e195ca0a.jpg",
"jobTitle": "Directeur",
"agentStatus": "independent",
"agentRegistrationNumber": "CPI 3101 2020 000 012 345"
},
{
"id": "618a35a36d932054e195ca0b",
"firstName": "Marie",
"lastName": "Martin",
"phone": "+33698765432",
"jobTitle": "Conseillère",
"agentStatus": "employee"
}
],
"page": 1,
"limit": 100,
"hasMore": false
}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
Liste paginée d'utilisateurs.